Rövid útmutató: A Data API Builder használata a PostgreSQL-lel

Ebben a Quickstart útmutatóban Data API Builder konfigurációs fájlokat hoz létre, hogy megcélozzon egy helyi PostgreSQL-adatbázist.

Előfeltételek

Jótanács

Másik lehetőségként nyissa meg ezt a rövid útmutatót a GitHub Codespacesben, és már telepítve van az összes fejlesztői előfeltétel. Egyszerűen hozza magával saját Azure-előfizetését. A GitHub-fiókok magukban foglalják a tárterületre és az alapórákra való jogosultságot díjmentesen. További információkért tekintse meg a GitHub-fiókokhoz tartozó tárterületet és alapórákat.

A Data API builder parancssori felületének telepítése

A Microsoft.DataApiBuilder csomagot telepítse a NuGetből, mint egy .NET-eszköz.

Használja a dotnet tool install-t a Microsoft.DataApiBuilder legújabb verziójának telepítéséhez a --global argumentummal.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Megjegyzés:

Ha a csomag már telepítve van, frissítse a csomagot a következővel dotnet tool update: .
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Ellenőrizze, hogy az eszköz telepítve van-e a dotnet tool list--global argumentum használatával.
```
dotnet tool list --global
```

A helyi adatbázis konfigurálása

Először konfigurálja és futtassa a helyi adatbázist. Ezután létrehozhat egy új tárolót mintaadatokkal.

Kérje le a tárolólemezkép legújabb példányát a postgres:16 Docker Hubról.
```
docker pull postgres:16
```
Indítsa el a Docker-tárolót a jelszó beállításával és az 5432-s port közzétételével. Cserélje le <your-password> egyéni jelszóra.
```
docker run \
    --publish 5432:5432 \
    --env "POSTGRES_PASSWORD=<your-password>" \
    --detach \
    postgres:16
```
Csatlakozzon a helyi adatbázishoz az előnyben részesített adatkezelési környezet használatával. Ilyen például a pgAdmin és a Visual Studio Code PostgreSQL-bővítménye.

Jótanács

Ha a Docker Linux-tárolólemezképekhez alapértelmezett hálózatkezelést használ, a kapcsolati sztring valószínűleg az lesz Host=localhost;Port=5432;User ID=postgres;Password=<your-password>;. Cserélje le <your-password> a korábban beállított jelszóra.

Hozzon létre egy új bookshelf adatbázist.

DROP DATABASE IF EXISTS bookshelf;

CREATE DATABASE bookshelf;

Hozzon létre egy új dbo.authors táblát, és alapszintű adatokkal szórja be a táblát.

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

Konfigurációs fájlok létrehozása

Hozzon létre egy alapkonfigurációs fájlt a DAB CLI használatával. Ezután adjon hozzá egy fejlesztési konfigurációs fájlt az aktuális hitelesítő adataival.

Hozzon létre egy tipikus konfigurációs fájlt a következő használatával dab init: . Adja hozzá az argumentumot az --connection-string adatbázis-kapcsolati karakterlánccal az első szakaszból. Cserélje le <your-password> az útmutatóban korábban beállított jelszóra. Továbbá, adja hozzá az Database=bookshelf értéket a kapcsolati sztringhez.
```
dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
```

Author entitás hozzáadása a következő használatával: dab add.

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

API tesztelése a helyi adatbázissal

Most indítsa el a Data API Builder eszközt annak ellenőrzéséhez, hogy a konfigurációs fájlok egyesítve vannak-e a fejlesztés során.

Az eszköz futtatására és API-végpontok létrehozására használható dab start az entitás számára.
```
dab start
```
Az eszköz kimenetének tartalmaznia kell a futó API-hoz való navigáláshoz használandó címet.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Jótanács

Ebben a példában az alkalmazás az localhost porton fut. Előfordulhat, hogy a futó alkalmazás címe és portja eltérő.
Először próbálja ki manuálisan az API-t egy GET-kérés /api/Authorkiadásával.

Jótanács

Ebben a példában az URL-cím a következő: https://localhost:5000/api/Author. Erre az URL-címre a webböngészővel navigálhat.
Ezután lépjen a Swagger dokumentációs oldalára a következő helyen /swagger: .

Jótanács

Ebben a példában az URL-cím a következő: https://localhost:5000/swagger. Ehhez az URL-címhez a webböngészővel is navigálhat.

Következő lépés

REST-végpontok

Visszajelzés

Hasznosnak találta ezt az oldalt?

Last updated on 2025-07-17