Guida introduttiva: Usare il Costruttore API dati con SQL

2025-06-11

In questa guida introduttiva si compila un set di file di configurazione di Generatore API dati per specificare come destinazione un database SQL locale.

Prerequisiti

Docker
.NET 8
Un client di gestione dei dati
- Se non è installato un client, installare Azure Data Studio

Suggerimento

In alternativa, aprire questa guida introduttiva in GitHub Codespaces con tutti i prerequisiti per gli sviluppatori già installati. È sufficiente usare la propria sottoscrizione di Azure. Gli account GitHub includono un entitlement di archiviazione e ore di core senza costi. Per altre informazioni, vedere l'articolo sullo spazio di archiviazione e le ore di core inclusi per gli account GitHub.

Installare il CLI di Data API Builder

Installare il Microsoft.DataApiBuilder pacchetto da NuGet come strumento .NET.

Usa dotnet tool install per installare la versione più recente di Microsoft.DataApiBuilder con l'argomento --global.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Annotazioni

Se il pacchetto è già installato, aggiornare invece il pacchetto usando dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Verifica che lo strumento sia installato usando dotnet tool list con l'argomento --global.
```
dotnet tool list --global
```

Configurare il database locale

Per iniziare, configurare ed eseguire il database locale per impostare le credenziali pertinenti. È quindi possibile eseguire il seeding del database con dati di esempio.

Ottieni l'ultima copia dell'immagine del contenitore da Docker Hub mcr.microsoft.com/mssql/server:2022-latest.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```
Avviare il contenitore Docker impostando la password, accettando il contratto di licenza con l'utente finale e pubblicando la porta 1433. Sostituire <your-password> con una password personalizzata.
```
docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest
```
Connettersi al database locale usando l'ambiente di gestione dei dati preferito. Gli esempi includono, ma non sono limitati a: SQL Server Management Studio, Azure Data Studio e l'estensione SQL Server per Visual Studio Code.

Suggerimento

Se si usa la rete predefinita per le immagini del contenitore Docker Linux, è probabile che la stringa di connessione sia Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. Sostituire <your-password> con la password impostata in precedenza.

Creare un nuovo bookshelf database e usare il database per le query rimanenti.

DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO

Creare una nuova dbo.authors tabella e inizializzarla con dati di base.

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

Creare i file di configurazione

Creare un file di configurazione di base usando l'interfaccia della riga di comando di DAB. Aggiungere quindi un file di configurazione di sviluppo con le credenziali correnti.

Creare un file di configurazione tipico usando dab init. Aggiungi l'argomento --connection-string con la stringa di connessione del database dalla prima sezione. Sostituire <your-password> con la password impostata in precedenza in questa guida. Aggiungere anche il Database=bookshelf valore alla stringa di connessione.
```
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;"
```

Aggiungere un'entità Author usando dab add.

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

Testare l'API con il database locale

Avviare ora lo strumento Generatore API dati per verificare che i file di configurazione vengano uniti durante lo sviluppo.

Usare dab start per eseguire lo strumento e creare endpoint API per l'entità.
```
dab start
```
L'output dello strumento deve includere l'indirizzo da usare per passare all'API in esecuzione.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Suggerimento

In questo esempio l'applicazione viene eseguita sulla localhost porta 5000. L'applicazione in esecuzione può avere un indirizzo e una porta diversi.
Provare prima di tutto l'API manualmente inviando una richiesta GET a /api/Author.

Suggerimento

In questo esempio l'URL sarà https://localhost:5000/api/Author. È possibile passare a questo URL usando il Web browser.
Passare quindi alla pagina della documentazione di Swagger all'indirizzo /swagger.

Suggerimento

In questo esempio l'URL sarà https://localhost:5000/swagger. Anche in questo caso, è possibile passare a questo URL usando il Web browser.

Passo successivo

Guida introduttiva: Distribuire il generatore di API dati in Azure

Condividi tramite