Inicio rápido: Uso de Data API Builder con MySQL

2025-06-11

En este inicio rápido, creará un conjunto de archivos de configuración del Generador de API de datos para tener como destino una base de datos MySQL local.

Prerrequisitos

Docker
.NET 8
Un cliente de administración de datos
- Si no tiene instalado un cliente, instale Azure Data Studio.

Sugerencia

Como alternativa, abra este inicio rápido en GitHub Codespaces con todos los requisitos previos para desarrolladores ya instalados. Solo tiene que traer su propia suscripción de Azure. Las cuentas de GitHub incluyen un derecho de almacenamiento y horas de núcleo sin costo alguno. Para obtener más información, consulte el almacenamiento y las horas de núcleo incluidas para las cuentas de GitHub.

Instalación de la CLI de Data API Builder

Instale el Microsoft.DataApiBuilder paquete desde NuGet como una herramienta de .NET.

Utiliza dotnet tool install para instalar la versión más reciente de Microsoft.DataApiBuilder con el argumento --global.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Nota:

Si el paquete ya está instalado, actualice el paquete en su lugar mediante dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Compruebe que la herramienta está instalada con el parámetro --global usando dotnet tool list.
```
dotnet tool list --global
```

Configuración de la base de datos local

Empiece por configurar y ejecutar la base de datos local. A continuación, puede inicializar un nuevo contenedor con datos de ejemplo.

Obtenga la copia más reciente de la mysql:8 imagen de contenedor de Docker Hub.
```
docker pull mysql:8
```
Inicie el contenedor de Docker estableciendo la contraseña y el puerto de publicación 3306. Reemplace por <your-password> una contraseña personalizada.
```
docker run \
    --publish 3306:3306 \
    --env "MYSQL_ROOT_PASSWORD=<your-password>" \
    --detach \
    mysql:8
```
Conéctese a la base de datos local mediante el entorno de administración de datos preferido. Entre los ejemplos se incluyen, entre otros: MySQL Workbench, Azure Data Studio y el shell de MySQL para Visual Studio Code.

Sugerencia

Si usa el networking predeterminado para las imágenes de contenedor de Docker Linux, es probable que la cadena de conexión sea Server=localhost;Port=3306;Uid=root;Pwd=<your-password>;. Reemplace <your-password> por la contraseña que estableció anteriormente.
Cree una nueva bookshelf base de datos y use la base de datos para las consultas restantes.
```
CREATE DATABASE IF NOT EXISTS bookshelf;

USE bookshelf;
```

Cree una nueva dbo.authors tabla y resiega la tabla con datos básicos.

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

Creación de archivos de configuración

Cree un archivo de configuración de línea base mediante la CLI de DAB. A continuación, agregue un archivo de configuración de desarrollo con las credenciales actuales.

Cree un archivo de configuración típico mediante dab init. Agregue el argumento de cadena de conexión --connection-string de su base de datos desde la primera sección. Reemplace <your-password> por la contraseña que estableció anteriormente en esta guía. Además, agregue el Database=bookshelf valor a la cadena de conexión.
```
dab init --database-type "mysql" --host-mode "Development" --connection-string "Server=localhost;Port=3306;Database=bookshelf;Uid=root;Pwd=<your-password>;"
```

Agregue una entidad Author mediante dab add.

dab add Author --source "authors" --permissions "anonymous:*"

Consulta el archivo de configuración dab-config.json actual. El archivo debe incluir una implementación de línea base de la API con una sola entidad, un punto de conexión de LA API REST y un punto de conexión de GraphQL.

API de prueba con la base de datos local

Ahora, inicie la herramienta Generador de API de datos para validar que los archivos de configuración se combinan durante el desarrollo.

Use dab start para ejecutar la herramienta y crear puntos de conexión de API para la entidad.
```
dab start
```
La salida de la herramienta debe incluir la dirección que se va a usar para navegar a la API en ejecución.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Sugerencia

En este ejemplo, la aplicación se ejecuta en localhost el puerto 5000. La aplicación en ejecución puede tener una dirección y un puerto diferentes.
En primer lugar, pruebe la API manualmente mediante la emisión de una solicitud GET a /api/Author.

Sugerencia

En este ejemplo, la dirección URL sería https://localhost:5000/api/Author. Puede ir a esta dirección URL mediante el explorador web.
A continuación, vaya a la página de documentación de Swagger en /swagger.

Sugerencia

En este ejemplo, la dirección URL sería https://localhost:5000/swagger. De nuevo, puede navegar a esta dirección URL mediante el explorador web.

Paso siguiente

puntos de conexión REST

Compartir a través de