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

Статья
05/14/2024

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

Предварительные требования

Docker
.NET 8
Клиент управления данными
- Если у вас не установлен клиент, установите Azure Data 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, Azure Data Studio и расширение SQL Server для Visual Studio Code.

Совет

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

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO
```

Create новую 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

файлы конфигурации Create

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

Create типичный файл конфигурации с помощью 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 вручную, отправив запрос GET к /api/Author.

Совет

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

Совет

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

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

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

Поделиться через