Szybki start: używanie konstruktora interfejsu API danych z bazą danych SQL

Artykuł
05/14/2024

W tym przewodniku Szybki start utworzysz zestaw plików konfiguracji konstruktora interfejsu API danych przeznaczonych dla lokalnej bazy danych SQL.

Wymagania wstępne

Docker
.NET 8
Klient zarządzania danymi
- Jeśli nie masz zainstalowanego klienta, zainstaluj program Azure Data Studio

Porada

Alternatywnie otwórz ten przewodnik Szybki start w usłudze GitHub Codespaces z już zainstalowanymi wszystkimi wymaganiami wstępnymi dla deweloperów. Wystarczy przenieść własną subskrypcję platformy Azure. Konta usługi GitHub obejmują uprawnienia do magazynowania i godzin podstawowych bez ponoszenia kosztów. Aby uzyskać więcej informacji, zobacz uwzględnione godziny magazynowania i rdzeni dla kont usługi GitHub.

Instalowanie interfejsu wiersza polecenia konstruktora interfejsu API danych

Microsoft.DataApiBuilder Zainstaluj pakiet z narzędzia NuGet jako narzędzie .NET.

Użyj polecenia dotnet tool install , aby zainstalować najnowszą wersję obiektu Microsoft.DataApiBuilder z argumentem --global .
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Uwaga

Jeśli pakiet jest już zainstalowany, zamiast tego zaktualizujesz pakiet przy użyciu polecenia dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Sprawdź, czy narzędzie jest zainstalowane z dotnet tool list użyciem argumentu --global .
```
dotnet tool list --global
```

Konfigurowanie lokalnej bazy danych

Rozpocznij od skonfigurowania i uruchomienia lokalnej bazy danych w celu ustawienia odpowiednich poświadczeń. Następnie możesz zainicjować bazę danych przy użyciu przykładowych danych.

Pobierz najnowszą kopię obrazu kontenera mcr.microsoft.com/mssql/server:2022-latest z Docker Hub.
```
docker pull mcr.microsoft.com/mssql/server:2022-latest
```
Uruchom kontener platformy Docker, ustawiając hasło, akceptując umowę licencyjną użytkownika końcowego (EULA) i publikując port 1433. Zastąp <your-password> element hasłem niestandardowym.
```
docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest
```
Połącz się z lokalną bazą danych przy użyciu preferowanego środowiska zarządzania danymi. Przykłady obejmują, ale nie są ograniczone do: SQL Server Management Studio, narzędzia Azure Data Studio i rozszerzenia SQL Server dla Visual Studio Code.

Porada

Jeśli używasz domyślnej sieci dla obrazów kontenerów systemu Linux platformy Docker, parametry połączenia prawdopodobnie będzie .Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True; Zastąp <your-password> element hasłem ustawionym wcześniej.

Twórca nową bookshelf bazę danych i użyj bazy danych dla pozostałych zapytań.

DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO

Twórca nową dbo.authors tabelę i wypełniaj tabelę podstawowymi danymi.

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

pliki konfiguracji Twórca

Twórca pliku konfiguracji punktu odniesienia przy użyciu interfejsu wiersza polecenia języka DAB. Następnie dodaj plik konfiguracji programowania przy użyciu bieżących poświadczeń.

Twórca typowy plik konfiguracji przy użyciu polecenia dab init. --connection-string Dodaj argument z parametry połączenia bazy danych z pierwszej sekcji. Zastąp <your-password> element hasłem ustawionym wcześniej w tym przewodniku. Ponadto dodaj Database=bookshelf wartość do parametry połączenia.
```
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;"
```

Dodaj jednostkę Author przy użyciu polecenia dab add.

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

Testowanie interfejsu API przy użyciu lokalnej bazy danych

Teraz uruchom narzędzie konstruktora interfejsu API danych, aby sprawdzić, czy pliki konfiguracji są scalane podczas programowania.

Użyj dab start polecenia , aby uruchomić narzędzie i utworzyć punkty końcowe interfejsu API dla jednostki.
```
dab start
```
Dane wyjściowe narzędzia powinny zawierać adres używany do przechodzenia do uruchomionego interfejsu API.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Porada

W tym przykładzie aplikacja jest uruchomiona na localhost porcie 5000. Uruchomiona aplikacja może mieć inny adres i port.
Najpierw spróbuj ręcznie użyć interfejsu API, wysyłając żądanie GET do /api/Author.

Porada

W tym przykładzie adres URL będzie następujący: https://localhost:5000/api/Author. Możesz przejść do tego adresu URL przy użyciu przeglądarki internetowej.
Następnie przejdź do strony dokumentacji struktury Swagger pod adresem /swagger.

Porada

W tym przykładzie adres URL będzie następujący: https://localhost:5000/swagger. Ponownie możesz przejść do tego adresu URL przy użyciu przeglądarki internetowej.

Następny krok

Szybki start: wdrażanie konstruktora interfejsu API danych na platformie Azure

Udostępnij za pośrednictwem