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

Článek
05/14/2024

V tomto rychlém startu vytvoříte sadu konfiguračních souborů Tvůrce rozhraní API pro cílení na místní databázi SQL.

Požadavky

Docker
.NET 8
Klient správy dat
- Pokud nemáte nainstalovaného klienta, nainstalujte Azure Data Studio.

Tip

Případně můžete otevřít tento rychlý start v GitHub Codespaces s již nainstalovanými všemi požadavky pro vývojáře. Jednoduše si přineste vlastní předplatné Azure. Účty GitHub zahrnují nárok na hodiny úložiště a jádra bez poplatků. Další informace najdete v tématu zahrnuté hodiny úložiště a doby jádra pro účty GitHubu.

Instalace rozhraní příkazového řádku Tvůrce data API

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

Pomocí příkazu dotnet tool install nainstalujte nejnovější verzi nástroje Microsoft.DataApiBuilder s argumentem --global .
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Poznámka

Pokud už je balíček nainstalovaný, místo toho ho aktualizujete pomocí .dotnet tool update
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Pomocí argumentu --global ověřte, že je nástroj nainstalovaný s dotnet tool list nástrojem .
```
dotnet tool list --global
```

Konfigurace místní databáze

Začněte konfigurací a spuštěním místní databáze pro nastavení příslušných přihlašovacích údajů. Pak můžete databázi nasypat ukázkovými daty.

Získejte nejnovější kopii image kontejneru mcr.microsoft.com/mssql/server:2022-latest z Docker Hub.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```

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

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

Tip

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

Create novou bookshelf databázi a pro zbývající dotazy ji použijte.

DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO

Create novou dbo.authors tabulku a dosadíte do tabulky základní data.

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

Create konfigurační soubory

Create standardní konfigurační soubor pomocí ROZHRANÍ PŘÍKAZOVÉHO ŘÁDKU DAB. Pak přidejte konfigurační soubor pro vývoj s aktuálními přihlašovacími údaji.

Create typický konfigurační soubor pomocí .dab init --connection-string Přidejte argument s databází připojovací řetězec z první části. Nahraďte <your-password> heslem, které jste nastavili dříve v této příručce. Database=bookshelf Přidejte také hodnotu do připojovací řetězec.
```
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;"
```

Přidejte entitu Author (Autor ) 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 během vývoje sloučí.

Použijte dab start ke spuštění nástroje a vytvoření koncových bodů rozhraní API pro vaši entitu.
```
dab start
```
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]
```
Tip

V tomto příkladu aplikace běží na localhost portu 5000. Spuštěná aplikace může mít jinou adresu a port.
Nejprve vyzkoušejte rozhraní API ručně vydáním požadavku GET na /api/Authoradresu .

Tip

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.
Pak přejděte na stránku dokumentace ke Swaggeru na adrese /swagger.

Tip

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

Další krok

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

Sdílet prostřednictvím