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

Ebben a rövid útmutatóban a Data API Builder konfigurációs fájljainak készletét hozza létre egy helyi PostgreSQL-adatbázis megcélzásához.

Előfeltételek

• Docker
• .NET 8
• Adatkezelési ügyfél
  • Ha nincs telepítve ügyfél, telepítse az Azure Data Studiót

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

Telepítse a csomagot a Microsoft.DataApiBuilder NuGetből .NET-eszközként.

1. A paranccsal dotnet tool install telepítheti a legújabb verziót Microsoft.DataApiBuilder az --global argumentummal.

   dotnet tool install --global Microsoft.DataApiBuilder
   

   Megjegyzés

   Ha a csomag már telepítve van, a használatával frissíti a csomagot dotnet tool update.

   dotnet tool update --global Microsoft.DataApiBuilder
   

2. Ellenőrizze, hogy az eszköz telepítve van-e az --global argumentum használatávaldotnet tool list.

   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.

1. Szerezze be a tárolórendszerkép legújabb példányát a postgres:16 Docker Hub.

   docker pull postgres:16
   

2. 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 a elemet <your-password> egy egyéni jelszóra.

   docker run \
       --publish 5432:5432 \
       --env "POSTGRES_PASSWORD=<your-password>" \
       --detach \
       postgres:16
   

3. Csatlakozzon a helyi adatbázishoz az előnyben részesített adatkezelési környezettel. Ilyen például a pgAdmin, az Azure Data Studio és a Visual Studio Code PostgreSQL-bővítménye.

   Tipp

   Ha alapértelmezett hálózatkezelést használ a Docker Linux-tárolórendszerképekhez, a kapcsolati karakterlánc valószínűleg a következő leszHost=localhost;Port=5432;User ID=postgres;Password=<your-password>;: . Cserélje le a elemet <your-password> a korábban beállított jelszóra.

4. Létrehozás új bookshelf adatbázist.

   DROP DATABASE IF EXISTS bookshelf;
   
   CREATE DATABASE bookshelf;
   

5. Létrehozás 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ás

Létrehozás 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.

1. Létrehozás egy tipikus konfigurációs fájlt a használatávaldab init. Adja hozzá az argumentumot az --connection-string adatbázis kapcsolati karakterlánc az első szakaszból. Cserélje le a elemet <your-password> az útmutatóban korábban beállított jelszóra. Adja hozzá az értéket a Database=bookshelf kapcsolati karakterlánc.

   dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
   

2. Author entitás hozzáadása a paranccsal 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ülnek-e a fejlesztés során.

1. Az dab start eszközzel futtathatja az eszközt, és API-végpontokat hozhat létre az entitáshoz.

   dab start
   

2. Az eszköz kimenetének tartalmaznia kell a futó API-hoz való navigáláshoz használni kívánt címet.

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

   Tipp

   Ebben a példában az alkalmazás az 5000-s porton localhost fut. Előfordulhat, hogy a futó alkalmazásnak más címe és portja van.

3. Először próbálja ki manuálisan az API-t egy GET-kérés kiadásával a következőnek /api/Author: .

   Tipp

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

4. Ezután lépjen a Swagger dokumentációs oldalára a címen /swagger.

   Tipp

   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