Megosztás a következőn keresztül:

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

Ebben a rövid útmutatóban a Data API Builder konfigurációs fájljait készíti el egy helyi SQL-adatbázis megcélzásához.

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.

Megnyitás a GitHub Codespaces-ben

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.

  1. 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

  2. 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 a megfelelő hitelesítő adatok beállításához. Ezután mintaadatokkal vetheti be az adatbázist.

  1. Kérje le a tárolólemezkép legújabb példányát a mcr.microsoft.com/mssql/server:2022-latest Docker Hubról.

    docker pull mcr.microsoft.com/mssql/server:2022-latest

  2. Indítsa el a docker-tárolót a jelszó beállításával, a végfelhasználói licencszerződés (EULA) elfogadásával és az 1433-at tartalmazó port közzétételével. Cserélje le <your-password> egyéni jelszóra.

    docker run \
    --env "ACCEPT_EULA=Y" \
    --env "MSSQL_SA_PASSWORD=<your-password>" \
    --publish 1433:1433 \
    --detach \
    mcr.microsoft.com/mssql/server:2022-latest

  3. Csatlakozzon a helyi adatbázishoz az előnyben részesített adatkezelési környezet használatával. Ilyenek például az SQL Server Management Studio és a Visual Studio Code SQL Server-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 Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. Cserélje le <your-password> a korábban beállított jelszóra.

  4. Hozzon létre egy új bookshelf adatbázist, és használja az adatbázist a fennmaradó lekérdezésekhez.

    DROP DATABASE IF EXISTS bookshelf;
GO

CREATE DATABASE bookshelf;
GO

USE bookshelf;
GO

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

    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

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.

  1. 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 "mssql" --host-mode "Development" --connection-string "Server=localhost,1433;User Id=sa;Database=bookshelf;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;"

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

    dab add Author --source "dbo.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.

  1. 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

  2. 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ő.

  3. 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.

  4. 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

Rövid útmutató: A Data API Builder üzembe helyezése az Azure-ban

  • Last updated on