Rychlý start: Použití Tvůrce rozhraní Data API s SQL

V tomto rychlém startu vytvoříte sadu konfiguračních souborů tvůrce dat, které budou cílit na místní databázi SQL.

Požadavky

• Docker
• .NET 8
• Klient pro správu dat
  • Pokud nemáte nainstalovaného klienta, nainstalujte si Azure Data Studio.

Návod

Případně otevřete tento rychlý start v GitHub Codespaces se všemi požadavky vývojáře, které už jsou nainstalované. Jednoduše přineste vlastní předplatné Azure. Účty GitHubu zahrnují nárok na úložiště a hodiny jádra bez poplatků. Další informace najdete v zahrnutých hodinách úložiště a jader pro účty GitHubu.

Instalovat Data API builder CLI

Nainstalujte balíček Microsoft.DataApiBuilder z NuGetu jako nástroj .NET.

1. Použijte dotnet tool install k instalaci nejnovější verze Microsoft.DataApiBuilder s argumentem --global.

   dotnet tool install --global Microsoft.DataApiBuilder
   

   Poznámka:

   Pokud je balíček již nainstalován, aktualizujte balíček místo toho pomocí dotnet tool update.

   dotnet tool update --global Microsoft.DataApiBuilder
   

2. Pomocí argumentu dotnet tool list ověřte, že je nástroj nainstalovaný--global.

   dotnet tool list --global
   

Konfigurace místní databáze

Začněte tím, že nakonfigurujete a spustíte místní databázi, aby se nastavily příslušné přihlašovací údaje. Pak můžete databázi osítit ukázkovými daty.

1. Získejte nejnovější kopii image kontejneru mcr.microsoft.com/mssql/server:2022-latest z Docker Hubu.

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

2. Spusťte kontejner Dockeru nastavením hesla, přijetím licenční smlouvy s koncovým uživatelem (EULA) a publikováním portu 1433. Nahraďte <your-password> vlastním heslem.

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

3. Připojte se k místní databázi pomocí upřednostňovaného prostředí pro správu dat. Mezi příklady patří: SQL Server Management Studio a rozšíření SQL Serveru pro Visual Studio Code.

   Návod

   Pokud pro image kontejnerů Dockeru pro Linux používáte výchozí sítě, připojovací řetězec pravděpodobně bude Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. Nahraďte <your-password> dříve nastaveným heslem.

4. Vytvořte novou bookshelf databázi a použijte ji pro zbývající dotazy.

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

5. Vytvořte novou dbo.authors tabulku a naplňte ji základními daty.

   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
   

Vytvoření konfiguračních souborů

Vytvořte základní konfigurační soubor pomocí rozhraní příkazového řádku DAB. Pak přidejte konfigurační soubor pro vývoj s vašimi aktuálními přihlašovacími údaji.

1. Vytvořte typický konfigurační soubor pomocí dab initpříkazu . --connection-string Přidejte argument s připojovacím řetězcem databáze z první části. Nahraďte <your-password> heslem, které jste nastavili dříve v této příručce. Také přidejte hodnotu Database=bookshelf do připojovacího řetězce.

   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. Přidejte entitu Author pomocí dab add.

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

Testování rozhraní API s místní databází

Teď spusťte nástroj Tvůrce rozhraní Data API a ověřte, že se konfigurační soubory sloučí během vývoje.

1. Slouží dab start ke spuštění nástroje a vytvoření koncových bodů rozhraní API pro vaši entitu.

   dab start
   

2. Výstup nástroje by měl obsahovat adresu, která se má použít k přechodu na spuštěné rozhraní API.

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

   Návod

   V tomto příkladu aplikace běží na localhost portu 5000. Spuštěná aplikace může mít jinou adresu a port.

3. Nejprve zkuste rozhraní API ručně vydáním požadavku GET na /api/Author.

   Návod

   V tomto příkladu by adresa URL byla https://localhost:5000/api/Author. Na tuto adresu URL můžete přejít pomocí webového prohlížeče.

4. Dále přejděte na stránku dokumentace Swaggeru na adrese /swagger.

   Návod

   V tomto příkladu by adresa URL byla https://localhost:5000/swagger. Znovu můžete přejít na tuto adresu URL pomocí webového prohlížeče.

Další krok

Rychlý start: Nasazení Tvůrce rozhraní Data API do Azure