Sdílet prostřednictvím


Rychlý start: Použití tvůrce rozhraní Data API s MySQL

V tomto rychlém startu vytvoříte sadu konfiguračních souborů Tvůrce rozhraní Data API pro cílení na místní databázi MySQL.

Požadavky

Návod

Případně otevřete tento rychlý start v GitHub Codespaces se všemi požadavky vývojáře, které už jsou nainstalované. Jednoduše přineste vlastní předplatné Azure. Účty GitHubu zahrnují nárok na úložiště a hodiny jádra bez poplatků. Další informace najdete v zahrnutých hodinách úložiště a jader pro účty GitHubu.

Otevřít v GitHub Codespaces

Instalovat Data API builder CLI

Nainstalujte balíček Microsoft.DataApiBuilder z NuGetu jako nástroj .NET.

  1. Použijte dotnet tool install k instalaci nejnovější verze Microsoft.DataApiBuilder s argumentem --global.

    dotnet tool install --global Microsoft.DataApiBuilder
    

    Poznámka:

    Pokud je balíček již nainstalován, aktualizujte balíček místo toho pomocí dotnet tool update.

    dotnet tool update --global Microsoft.DataApiBuilder
    
  2. Pomocí argumentu dotnet tool list ověřte, že je nástroj nainstalovaný--global.

    dotnet tool list --global
    

Konfigurace místní databáze

Začněte konfigurací a spuštěním místní databáze. Pak můžete vytvořit nový kontejner s ukázkovými daty.

  1. Získejte nejnovější kopii image kontejneru mysql:8 z Docker Hubu.

    docker pull mysql:8
    
  2. Spusťte kontejner Dockeru nastavením hesla a publikování portu 3306. Nahraďte <your-password> vlastním heslem.

    docker run \
        --publish 3306:3306 \
        --env "MYSQL_ROOT_PASSWORD=<your-password>" \
        --detach \
        mysql:8
    
  3. Připojte se k místní databázi pomocí upřednostňovaného prostředí pro správu dat. Mezi příklady patří: MySQL Workbench a prostředí MySQL pro Visual Studio Code, ale nejsou omezené.

    Návod

    Pokud pro image kontejnerů Dockeru pro Linux používáte výchozí sítě, připojovací řetězec pravděpodobně bude Server=localhost;Port=3306;Uid=root;Pwd=<your-password>;. Nahraďte <your-password> dříve nastaveným heslem.

  4. Vytvořte novou bookshelf databázi a použijte ji pro zbývající dotazy.

    CREATE DATABASE IF NOT EXISTS bookshelf;
    
    USE bookshelf;
    
  5. Vytvořte novou dbo.authors tabulku a naplňte ji základními daty.

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

Vytvoření konfiguračních souborů

Vytvořte základní konfigurační soubor pomocí rozhraní příkazového řádku DAB. Pak přidejte konfigurační soubor pro vývoj s vašimi aktuálními přihlašovacími údaji.

  1. Vytvořte typický konfigurační soubor pomocí dab initpříkazu . --connection-string Přidejte argument s připojovacím řetězcem databáze z první části. Nahraďte <your-password> heslem, které jste nastavili dříve v této příručce. Také přidejte hodnotu Database=bookshelf do připojovacího řetězce.

    dab init --database-type "mysql" --host-mode "Development" --connection-string "Server=localhost;Port=3306;Database=bookshelf;Uid=root;Pwd=<your-password>;"
    
  2. Přidejte entitu Author pomocí dab add.

    dab add Author --source "authors" --permissions "anonymous:*"
    
  3. Prohlédněte si aktuální konfigurační soubor dab-config.json. Tento soubor by měl obsahovat základní implementaci vašeho rozhraní API s jednou entitou, koncovým bodem rozhraní REST API a koncovým bodem GraphQL.

Testování rozhraní API s místní databází

Teď spusťte nástroj Tvůrce rozhraní Data API a ověřte, že se konfigurační soubory sloučí během vývoje.

  1. Slouží dab start ke spuštění nástroje a vytvoření koncových bodů rozhraní API pro vaši entitu.

    dab start
    
  2. Výstup nástroje by měl obsahovat adresu, která se má použít k přechodu na spuštěné rozhraní API.

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

    Návod

    V tomto příkladu aplikace běží na localhost portu 5000. Spuštěná aplikace může mít jinou adresu a port.

  3. Nejprve zkuste rozhraní API ručně vydáním požadavku GET na /api/Author.

    Návod

    V tomto příkladu by adresa URL byla https://localhost:5000/api/Author. Na tuto adresu URL můžete přejít pomocí webového prohlížeče.

  4. Dále přejděte na stránku dokumentace Swaggeru na adrese /swagger.

    Návod

    V tomto příkladu by adresa URL byla https://localhost:5000/swagger. Znovu můžete přejít na tuto adresu URL pomocí webového prohlížeče.

Další krok