Snabbstart: Använda Data API Builder med SQL

I den här snabbstarten skapar du en uppsättning konfigurationsfiler för Data API Builder för att rikta in dig på en lokal SQL-databas.

Förutsättningar

• Docker
• .NET 8
• En datahanteringsklient
  • Om du inte har en klient installerad installerar du Azure Data Studio

Installera CLI för Data API-builder

Microsoft.DataApiBuilder Installera paketet från NuGet som ett .NET-verktyg.

1. Använd dotnet tool install för att installera den senaste versionen av Microsoft.DataApiBuilder med --global argumentet .

   dotnet tool install --global Microsoft.DataApiBuilder
   

   Anmärkning

   Om paketet redan är installerat uppdaterar du paketet i stället med .dotnet tool update

   dotnet tool update --global Microsoft.DataApiBuilder
   

2. Kontrollera att verktyget är installerat med dotnet tool list genom att använda argumentet --global.

   dotnet tool list --global
   

Konfigurera den lokala databasen

Börja med att konfigurera och köra den lokala databasen för att ange relevanta autentiseringsuppgifter. Sedan kan du seeda databasen med exempeldata.

1. Hämta den senaste kopian av containeravbildningen mcr.microsoft.com/mssql/server:2022-latest från Docker Hub.

   docker pull mcr.microsoft.com/mssql/server:2022-latest
   

2. Starta docker-containern genom att ange lösenordet, godkänna licensavtalet för slutanvändare (EULA) och publicera port 1433. Ersätt <your-password> med ett anpassat lösenord.

   docker run \
       --env "ACCEPT_EULA=Y" \
       --env "MSSQL_SA_PASSWORD=<your-password>" \
       --publish 1433:1433 \
       --detach \
       mcr.microsoft.com/mssql/server:2022-latest
   

3. Anslut till din lokala databas med hjälp av önskad datahanteringsmiljö. Exempel är, men är inte begränsade till: SQL Server Management Studio och SQL Server-tillägget för Visual Studio Code.

   Tips/Råd

   Om du använder standardnätverk för dina Docker Linux-containeravbildningar blir anslutningssträngen troligen Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. Ersätt <your-password> med det lösenord som du angav tidigare.

4. Skapa en ny bookshelf databas och använd databasen för dina återstående frågor.

   DROP DATABASE IF EXISTS bookshelf;
   GO
   
   CREATE DATABASE bookshelf;
   GO
   
   USE bookshelf;
   GO
   

5. Skapa en ny dbo.authors tabell och mata in grundläggande data i tabellen.

   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
   

Skapa konfigurationsfiler

Skapa en baslinjekonfigurationsfil med hjälp av DAB CLI. Lägg sedan till en utvecklingskonfigurationsfil med dina aktuella autentiseringsuppgifter.

1. Skapa en typisk konfigurationsfil med .dab init --connection-string Lägg till argumentet med databasanslutningssträngen från det första avsnittet. Ersätt <your-password> med lösenordet som du angav tidigare i den här guiden. Lägg också till Database=bookshelf värdet i anslutningssträngen.

   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;"
   

2. Lägg till en entitet för författare med hjälp av dab add.

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

Testa API:et med den lokala databasen

Starta nu verktyget Data API Builder för att verifiera att dina konfigurationsfiler sammanfogas under utvecklingen.

1. Använd dab start för att köra verktyget och skapa API-slutpunkter för din entitet.

   dab start
   

2. Utdata från verktyget ska innehålla adressen som ska användas för att navigera till api:et som körs.

         Successfully completed runtime initialization.
   info: Microsoft.Hosting.Lifetime[14]
         Now listening on: <http://localhost:5000>
   info: Microsoft.Hosting.Lifetime[0]
   

   Tips/Råd

   I det här exemplet körs programmet på localhost port 5000. Ditt program som körs kan ha en annan adress och port.

3. Prova först API:et manuellt genom att utfärda en GET-begäran till /api/Author.

   Tips/Råd

   I det här exemplet skulle URL:en vara https://localhost:5000/api/Author. Du kan navigera till den här URL:en med hjälp av webbläsaren.

4. Gå sedan till sidan Swagger-dokumentation: /swagger.

   Tips/Råd

   I det här exemplet skulle URL:en vara https://localhost:5000/swagger. Återigen kan du navigera till den här URL:en med hjälp av webbläsaren.

Nästa steg