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

V tomto rychlém úvodu vytvoříte sadu konfiguračních souborů pro Data API Builder, které budou cílit na emulátor Azure Cosmos DB pro NoSQL.

Požadavky

• Docker
• technologie .NET 8

Návod

Případně otevřete tento rychlý start v GitHub Codespaces se všemi už nainstalovanými požadavky pro vývojáře. Jednoduše přineste vlastní předplatné Azure. GitHub účty zahrnují zdarma přidělení úložiště a výpočetních hodin. Další informace najdete v tématu zahrnované úložiště a hlavní hodiny pro účty GitHub.

Instalovat Data API builder CLI

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

1. Použijte k instalaci nejnovější verze s argumentem .

   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 --global Microsoft.DataApiBuilder
   

2. Pomocí argumentu ověřte, že je nástroj nainstalovaný.

   dotnet tool list --global
   

Konfigurace místní databáze

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

1. Získejte nejnovější kopii image kontejneru mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:latest z Docker Hub.

   docker pull mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:latest
   

2. Spusťte kontejner Dockeru publikováním portu 8081 a rozsahu portů 10250–10255.

   docker run \
       --publish 8081:8081 \
       --publish 10250-10255:10250-10255 \
       --detach \
       mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:latest
   

3. Stáhněte si samopodepsaný certifikát pro emulátor

   curl -k https://localhost:8081/_explorer/emulator.pem > ~/emulatorcert.crt
   

4. Nainstalujte certifikát podepsaný svým držitelem pomocí kroků Bash pro Linux nebo kroků PowerShell pro Windows.

   sudo cp ~/emulatorcert.crt /usr/local/share/ca-certificates/
   sudo update-ca-certificates
   

   certutil -f -addstore "Root" emulatorcert.crt
   

5. Připojte se k místní databázi pomocí upřednostňovaného prostředí pro správu dat. Mezi příklady patří: rozšíření Azure Databases pro Visual Studio Code.

   Návod

   Výchozí připojovací řetězec emulátoru je AccountEndpoint=https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==.

6. Vytvořte novou databázi a kontejner.

7. Naplníte kontejner s těmito základními daty JSON.

   [
     {
       "id": "01",
       "firstName": "Henry",
       "lastName": "Ross"
     },
     {
       "id": "02",
       "firstName": "Jacob",
       "middleName": "A.",
       "lastName": "Hancock"
     },
     {
       "id": "03",
       "firstName": "Sydney",
       "lastName": "Mattos"
     },
     {
       "id": "04",
       "firstName": "Jordan",
       "lastName": "Mitchell"
     },
     {
       "id": "05",
       "firstName": "Victoria",
       "lastName": "Burke"
     },
     {
       "id": "06",
       "firstName": "Vance",
       "lastName": "DeLeon"
     },
     {
       "id": "07",
       "firstName": "Reed",
       "lastName": "Flores"
     },
     {
       "id": "08",
       "firstName": "Felix",
       "lastName": "Henderson"
     },
     {
       "id": "09",
       "firstName": "Avery",
       "lastName": "Howard"
     },
     {
       "id": "10",
       "firstName": "Violet",
       "lastName": "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 nový soubor s názvem schema.gql s tímto obsahem schématu.

   type Author @model {
     id: ID!
     firstName: String!
     middleName: String
     lastName: String!
   }
   

   Poznámka:

   V tomto příkladu nezadá argument. Pokud je tento argument vynechán, DAB mapuje název typu GraphQL () na název entity (). Názvy se musí přesně shodovat a rozlišují malá a velká písmena.

2. Vytvořte typický konfigurační soubor pomocí příkazu . Přidejte argument --connection-string s výchozím připojovacím řetězcem emulátoru.

   dab init --database-type "cosmosdb_nosql" --host-mode "Development" --cosmosdb_nosql-database bookshelf --graphql-schema schema.gql --connection-string "AccountEndpoint=https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw=="
   

3. Přidejte entitu Author pomocí .

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

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ží 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 portu 5000. Spuštěná aplikace může mít jinou adresu a port.

3. Přejděte ke koncovému bodu GraphQL tak, že navštívíte a spustíte tuto operaci.

   Před dotazováním GraphQL můžete spuštění ověřit otevřením kořenového koncového bodu (). Správná odpověď zahrnuje pole jako například ..., ..., a ....

   query {
     authors {
       items {
         id
         firstName
         lastName
       }
     }
   }
   

   Návod

   V tomto příkladu je adresa URL .

   Vzhledem k tomu, že tento rychlý průvodce používá navigaci v prohlížeči, otevře se Nitro. V produkčním režimu se Nitro nezobrazuje pro navigaci v prohlížeči.

Další krok

Quickstart: Nasazení Tvůrce rozhraní Data API do Azure

Související obsah

• Nastavte tvůrce rozhraní DATA API pro Azure Cosmos DB pro NoSQL
• Dostupnost funkcí pro tvůrce rozhraní Data API