Быстрое начало: Использование конструктора API данных с SQL

В этом кратком руководстве вы создадите набор конфигурационных файлов для построителя Data API, нацеленных на локальную базу данных SQL.

Предпосылки

Docker
.NET 8
Клиент управления данными
- Если у вас нет клиента, установите SQL Server Management Studio.

Подсказка

Кроме того, откройте это краткое руководство в GitHub Codespaces, где уже установлены все требования для разработчиков. Используйте собственную подписку Azure. Учетные записи GitHub включают право на хранение и основные часы без затрат. Дополнительные сведения см . в разделе о хранилище и основных часах для учетных записей GitHub.

Установка интерфейса командной строки построителя API данных

Установите пакет Microsoft.DataApiBuilder из NuGet в качестве инструмента .NET.

Используйте dotnet tool install для установки последней версии Microsoft.DataApiBuilder, используя аргумент --global.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Замечание

Если пакет уже установлен, вместо этого обновите пакет, используя dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Убедитесь, что средство установлено с dotnet tool list помощью аргумента --global .
```
dotnet tool list --global
```

Настройка локальной базы данных

Начните с настройки и запуска локальной базы данных, чтобы задать соответствующие учетные данные. Затем можно заполнить базу данных примерами данных.

Получите последнюю копию mcr.microsoft.com/mssql/server:2022-latest образа контейнера из Docker Hub.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```
Запустите контейнер Docker, задав пароль, приняв лицензионное соглашение конечного пользователя (EULA) и публикуя порт 1433. Замените <your-password> настраиваемым паролем.
```
docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest
```
Подключитесь к локальной базе данных с помощью предпочтительной среды управления данными. Примеры включают в себя, но не ограничиваются: SQL Server Management Studio и расширение SQL Server для Visual Studio Code.

Подсказка

Если вы используете сеть по умолчанию для образов контейнеров Docker Linux, скорее всего, строка подключения будет Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. Замените <your-password> заданным ранее паролем.
Создайте новую bookshelf базу данных и используйте базу данных для оставшихся запросов.
```
DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO
```

Создайте новую dbo.authors таблицу и заполните её базовыми данными.

DROP TABLE IF EXISTS dbo.authors;
GO

CREATE TABLE dbo.authors
(
    id int not null primary key,
    first_name nvarchar(100) not null,
    middle_name nvarchar(100) null,
    last_name nvarchar(100) not null
)
GO

INSERT INTO dbo.authors VALUES
    (01, 'Henry', null, 'Ross'),
    (02, 'Jacob', 'A.', 'Hancock'),
    (03, 'Sydney', null, 'Mattos'),
    (04, 'Jordan', null, 'Mitchell'),
    (05, 'Victoria', null, 'Burke'),
    (06, 'Vance', null, 'DeLeon'),
    (07, 'Reed', null, 'Flores'),
    (08, 'Felix', null, 'Henderson'),
    (09, 'Avery', null, 'Howard'),
    (10, 'Violet', null, 'Martinez')
GO

Создание файлов конфигурации

Создайте файл базовой конфигурации с помощью ИНТЕРФЕЙСА командной строки DAB. Затем добавьте файл конфигурации разработки с текущими учетными данными.

Создайте типичный файл конфигурации с помощью dab init. Добавьте аргумент, содержащий строку --connection-string подключения к базе данных из первого раздела. Замените <your-password> на пароль, который вы задали ранее в этом руководстве. Кроме того, добавьте значение Database=bookshelf в строку подключения.
```
dab init --database-type "mssql" --host-mode "Development" --connection-string "Server=localhost,1433;User Id=sa;Database=bookshelf;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;"
```
Добавление сущности Author с помощью dab add.
```
dab add Author --source "dbo.authors" --permissions "anonymous:*"
```

Тестирование API с помощью локальной базы данных

Теперь запустите инструмент построителя API данных, чтобы убедиться, что файлы конфигурации объединяются в процессе разработки.

Используйте dab start для запуска инструмента и создания конечных точек API для вашей сущности.
```
dab start
```
Выходные данные средства должны содержать адрес, используемый для перехода к запущенному API.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Подсказка

В этом примере приложение выполняется через localhost порт 5000. Работающее приложение может иметь другой адрес и порт.
Во-первых, попробуйте использовать API вручную, выдав запрос /api/AuthorGET.

Подсказка

В этом примере URL-адрес будет иметь значение https://localhost:5000/api/Author. Вы можете открыть этот URL-адрес с помощью веб-браузера.
Затем перейдите на страницу документации Swagger по адресу /swagger.

Подсказка

В этом примере URL-адрес будет иметь значение https://localhost:5000/swagger. Опять же, вы можете перейти по этому URL-адресу с помощью веб-браузера.

Следующий шаг

Краткое руководство. Развертывание построителя API данных в Azure

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2025-07-17