Quickstart: Data API Builder gebruiken met SQL

Artikel
05/14/2024

In deze quickstart bouwt u een set configuratiebestanden voor Data API Builder voor een lokale SQL-database.

Vereisten

Docker
.NET 8
Een gegevensbeheerclient
- Als u geen client hebt geïnstalleerd, installeert u Azure Data Studio

Tip

U kunt deze quickstart ook openen in GitHub Codespaces, waarbij alle vereisten voor ontwikkelaars al zijn geïnstalleerd. Neem gewoon uw eigen Azure-abonnement mee. GitHub-accounts hebben gratis recht op opslag- en kernuren. Zie Inbegrepen opslag- en kernuren voor GitHub-accounts voor meer informatie.

De Data API Builder-CLI installeren

Installeer het Microsoft.DataApiBuilder pakket vanuit NuGet als een .NET-hulpprogramma.

Gebruik dotnet tool install om de nieuwste versie van de Microsoft.DataApiBuilder te installeren met het --global argument .
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Notitie

Als het pakket al is geïnstalleerd, werkt u het pakket bij met behulp van dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Controleer of het hulpprogramma is geïnstalleerd met dotnet tool list behulp van het --global argument .
```
dotnet tool list --global
```

De lokale database configureren

Begin met het configureren en uitvoeren van de lokale database om de relevante referenties in te stellen. Vervolgens kunt u de database met voorbeeldgegevens seeden.

Haal de meest recente kopie van de mcr.microsoft.com/mssql/server:2022-latest containerinstallatiekopie op uit Docker Hub.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```
Start de Docker-container door het wachtwoord in te stellen, de gebruiksrechtovereenkomst (EULA) te accepteren en poort 1433 te publiceren. Vervang door <your-password> een aangepast wachtwoord.
```
docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest
```
Maak verbinding met uw lokale database met behulp van uw voorkeursomgeving voor gegevensbeheer. Voorbeelden zijn, maar zijn niet beperkt tot: SQL Server Management Studio, Azure Data Studio en de SQL Server-extensie voor Visual Studio Code.

Tip

Als u standaardnetwerken gebruikt voor uw Docker Linux-containerinstallatiekopieën, is Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;de verbindingsreeks waarschijnlijk . Vervang door <your-password> het wachtwoord dat u eerder hebt ingesteld.

Creatie een nieuwe bookshelf database en gebruik de database voor de resterende query's.

DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO

Creatie een nieuwe dbo.authors tabel en seed de tabel met basisgegevens.

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

Creatie configuratiebestanden

Creatie een basislijnconfiguratiebestand met behulp van de DAB CLI. Voeg vervolgens een configuratiebestand voor ontwikkeling toe met uw huidige referenties.

Creatie een standaardconfiguratiebestand met behulp van dab init. Voeg het --connection-string argument toe met uw database verbindingsreeks uit de eerste sectie. Vervang door <your-password> het wachtwoord dat u eerder in deze handleiding hebt ingesteld. Voeg ook de Database=bookshelf waarde toe aan de verbindingsreeks.
```
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;"
```

Voeg een auteurentiteit toe met behulp van dab add.

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

Api testen met de lokale database

Start nu het hulpprogramma Data API Builder om te controleren of uw configuratiebestanden tijdens de ontwikkeling worden samengevoegd.

Gebruik dab start om het hulpprogramma uit te voeren en API-eindpunten voor uw entiteit te maken.
```
dab start
```
De uitvoer van het hulpprogramma moet het adres bevatten dat moet worden gebruikt om naar de actieve API te navigeren.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Tip

In dit voorbeeld wordt de toepassing uitgevoerd op localhost poort 5000. Uw actieve toepassing heeft mogelijk een ander adres en een andere poort.
Probeer eerst de API handmatig uit door een GET-aanvraag te verzenden naar /api/Author.

Tip

In dit voorbeeld is https://localhost:5000/api/Authorde URL . U kunt naar deze URL navigeren met behulp van uw webbrowser.
Navigeer vervolgens naar de Swagger-documentatiepagina op /swagger.

Tip

In dit voorbeeld is https://localhost:5000/swaggerde URL . Nogmaals, u kunt naar deze URL navigeren met behulp van uw webbrowser.

Volgende stap

Quickstart: Data API Builder implementeren in Azure

Delen via