Szybki start: korzystanie z konstruktora interfejsu API danych w usłudze PostgreSQL

Artykuł
05/14/2024

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

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 ze wszystkimi wymaganiami wstępnymi dla deweloperów, które zostały już zainstalowane. Po prostu przynieś własną subskrypcję platformy Azure. Konta usługi GitHub obejmują uprawnienia do magazynowania i godzin podstawowych bez 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ędzia .NET.

Użyj dotnet tool install polecenia , aby zainstalować najnowszą wersję Microsoft.DataApiBuilder argumentu --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 przy dotnet tool list użyciu argumentu --global .
```
dotnet tool list --global
```

Konfigurowanie lokalnej bazy danych

Rozpocznij od skonfigurowania i uruchomienia lokalnej bazy danych. Następnie możesz zainicjować nowy kontener z przykładowymi danymi.

Pobierz najnowszą kopię obrazu kontenera postgres:16 z Docker Hub.
```
docker pull postgres:16
```
Uruchom kontener platformy Docker, ustawiając hasło i publikując port 5432. Zastąp ciąg <your-password> hasłem niestandardowym.
```
docker run \
    --publish 5432:5432 \
    --env "POSTGRES_PASSWORD=<your-password>" \
    --detach \
    postgres:16
```
Połącz się z lokalną bazą danych przy użyciu preferowanego środowiska zarządzania danymi. Przykłady obejmują, ale nie są ograniczone do: pgAdmin, Azure Data Studio i rozszerzenia PostgreSQL dla Visual Studio Code.

Porada

Jeśli używasz domyślnej sieci dla obrazów kontenerów platformy Docker Linux, parametry połączenia prawdopodobnie będzie to Host=localhost;Port=5432;User ID=postgres;Password=<your-password>;. Zastąp <your-password> ciąg hasłem ustawionym wcześniej.

Twórca nowej bookshelf bazy danych.

DROP DATABASE IF EXISTS bookshelf;

CREATE DATABASE bookshelf;

Twórca nową dbo.authors tabelę i rozsiewuj tabelę z podstawowymi danymi.

CREATE TABLE IF NOT EXISTS authors
(
    id INT NOT NULL PRIMARY KEY,
    first_name VARCHAR(100) NOT NULL,
    middle_name VARCHAR(100),
    last_name VARCHAR(100) NOT NULL
);

INSERT INTO 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');

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 z bieżącymi poświadczeniami.

Twórca typowy plik konfiguracji przy użyciu polecenia dab init. --connection-string Dodaj argument z bazą danych parametry połączenia z pierwszej sekcji. Zastąp <your-password> ciąg hasłem ustawionym wcześniej w tym przewodniku. Ponadto dodaj Database=bookshelf wartość do parametry połączenia.
```
dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
```

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

dab add Author --source "public.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 działa 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 to 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 to https://localhost:5000/swagger. Ponownie możesz przejść do tego adresu URL przy użyciu przeglądarki internetowej.

Następny krok

Punkty końcowe REST

Udostępnij za pośrednictwem