Inicio rápido: Uso del generador de API de datos con SQL

Artículo
05/14/2024

En esta guía de inicio rápido, creará un conjunto de archivos de configuración del Generador de API de datos para dirigirse a una base de datos SQL local.

Requisitos previos

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. Basta con traer su propia suscripción de Azure. Las cuentas de GitHub incluyen un derecho de almacenamiento y horas básicas sin costo alguno. Para más información, consulte horas de almacenamiento y 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.

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

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

Configuración de la base de datos local

Empiece por configurar y ejecutar la base de datos local para establecer las credenciales pertinentes. A continuación, puede inicializar la base de datos con datos de ejemplo.

Obtenga la copia más reciente de la mcr.microsoft.com/mssql/server:2022-latest imagen de contenedor de Docker Hub.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```
Inicie el contenedor de Docker estableciendo la contraseña, aceptando el contrato de licencia de usuario final (CLUF) y publicando el puerto 1433. Reemplace por <your-password> una contraseña personalizada.
```
docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest
```
Conéctese a la base de datos local mediante el entorno de administración de datos preferido. Entre los ejemplos se incluyen, entre otros: SQL Server Management Studio, Azure Data Studio y la extensión SQL Server para Visual Studio Code.

Sugerencia

Si usa redes predeterminadas para las imágenes de contenedor de Docker Linux, es probable que el cadena de conexión sea Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. Reemplace por <your-password> la contraseña que estableció anteriormente.
Create una nueva bookshelf base de datos y use la base de datos para las consultas restantes.
```
DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO
```

Create una nueva dbo.authors tabla y inicializar la tabla con datos básicos.

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

Creación de archivos de configuración

Create 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.

Create un archivo de configuración típico mediante dab init. Agregue el argumento con la --connection-string base de datos cadena de conexión desde la primera sección. Reemplace por <your-password> la contraseña que estableció anteriormente en esta guía. Además, agregue el Database=bookshelf valor al cadena de conexión.
```
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;"
```

Agregue una entidad Author mediante dab add.

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

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 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 en 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 navegar 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

Inicio rápido: Implementación de Data API Builder en Azure

Compartir a través de