Краткий старт: Использование Построителя API данных с MySQL

2025-06-11

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

Предпосылки

Докер
.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
```

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

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

Получите последнюю копию mysql:8 образа контейнера из Docker Hub.
```
docker pull mysql:8
```
Запустите контейнер Docker, задав пароль и порт публикации 3306. Замените <your-password> настраиваемым паролем.
```
docker run \
    --publish 3306:3306 \
    --env "MYSQL_ROOT_PASSWORD=<your-password>" \
    --detach \
    mysql:8
```
Подключитесь к локальной базе данных с помощью предпочтительной среды управления данными. Примеры включают в себя, но не ограничиваются: MySQL Workbench, Azure Data Studio и оболочка MySQL для Visual Studio Code.

Подсказка

Если вы используете сеть по умолчанию для образов контейнеров Docker Linux, скорее всего, строка подключения будет Server=localhost;Port=3306;Uid=root;Pwd=<your-password>;. Замените <your-password> заданным ранее паролем.
Создайте новую bookshelf базу данных и используйте базу данных для оставшихся запросов.
```
CREATE DATABASE IF NOT EXISTS bookshelf;

USE bookshelf;
```

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

CREATE TABLE IF NOT EXISTS authors
(
    id INT NOT NULL PRIMARY KEY,
    first_name VARCHAR(100) NOT NULL,
    middle_name VARCHAR(100),
    last_name VARCHAR(100) NOT NULL
);

INSERT INTO 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');

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

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

Создайте типичный файл конфигурации с помощью dab init. Добавьте аргумент, содержащий строку --connection-string подключения к базе данных из первого раздела. Замените <your-password> на пароль, заданный ранее в этом руководстве. Кроме того, добавьте значение Database=bookshelf в строку подключения.
```
dab init --database-type "mysql" --host-mode "Development" --connection-string "Server=localhost;Port=3306;Database=bookshelf;Uid=root;Pwd=<your-password>;"
```
Добавление сущности Author с помощью dab add.
```
dab add Author --source "authors" --permissions "anonymous:*"
```
Просмотрите текущий файл конфигурации dab-config.json . Файл должен включать базовую реализацию API с одной сущностью, конечной точкой REST API и конечной точкой GraphQL.

Тестирование 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-адресу с помощью веб-браузера.

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

конечных точек REST