Hostování tvůrce rozhraní API pro data ve službě Azure Static Web Apps (Preview)

Diagram posloupnosti průvodce nasazením, včetně těchto umístění, v uvedeném pořadí: Přehled, Plán, Příprava, Publikování, Monitorování a Optimalizace Umístění Publikovat je aktuálně zvýrazněné.

Rychlé hostování tvůrce rozhraní DATA API ve službě Azure Static Web Apps pomocí pouze konfiguračního souboru Tato příručka obsahuje postup integrace tvůrce rozhraní DATA API se statickou webovou aplikací.

V této příručce si projděte postup vytvoření konfiguračního souboru DAB, hostování souboru jako součásti vaší aplikace a následné použití připojení k databázi ve službě Azure Static Web Apps.

Požadavky

Důležité

Podpora tvůrce rozhraní DATA API (DAB) ve službě Azure Static Web Apps pomocí databázových připojení je ve verzi Preview. Azure Static Web Apps používá pevnou verzi modulu DAB, která se může lišit od nejnovější stabilní verze JAZYKa DAB. Pokud chcete získat přístup k nejnovějším funkcím DAB, zvažte alternativního hostitele pro DAB pomocí nejnovější verze modulu z GitHubu, služby Microsoft Container Registry (Docker Hub) nebo NuGetu.

• Účet Azure s aktivním předplatným. Vytvoření účtu zdarma
• Azure Static Web Apps CLI Nainstalujte rozhraní příkazového řádku Static Web Apps (SWA).
• Rozhraní příkazového řádku pro tvůrce dat Nainstalujte rozhraní příkazového řádku DAB (Data API Builder).
• Existující podporovaná databáze adresovatelná z Azure.
• Existující webová aplikace v úložišti GitHub, které je možné nasadit do Azure Static Web Apps.
  • Pokud nemáte webovou aplikaci, vygenerujte úložiště se základní webovou aplikací.

Vytvoření statické webové aplikace

Začněte tak, že pomocí webu Azure Portal vytvoříte novou statickou webovou aplikaci Azure pomocí webové aplikace na GitHubu.

1. Přihlaste se k webu Azure Portal (https://portal.azure.com).

2. Vytvořte novou skupinu prostředků. Tuto skupinu prostředků použijete pro všechny nové prostředky v této příručce.

   

   Návod

   Doporučujeme pojmenovat tu skupinu prostředků msdocs-dab-swa. Všechny snímky obrazovky v této příručce používají tento název.

3. Vytvořte statickou webovou aplikaci Azure. Pomocí těchto nastavení můžete nakonfigurovat statickou webovou aplikaci.

   Nastavení	Hodnota
   skupina prostředků	Vyberte skupinu prostředků, kterou jste vytvořili dříve.
   název	Zadejte globálně jedinečný název.
   Typ plánu	Výběr nejlepší možnosti pro vaši úlohu
   Zdroj	Výběr GitHubu
   GitHub účet	Konfigurace účtu GitHubu, který má přístup k úložišti webových aplikací
   Organizace	Vyberte nadřazenou organizaci nebo uživatele úložiště.
   Úložiště	Vyberte název úložiště.
   Větev	Výběr primární větve

   

4. Počkejte na dokončení nasazení statické webové aplikace. Do úložiště se automaticky přidá pracovní postup GitHub Actions, který nasadí aplikaci do Azure Static Web Apps při každém nasdílení změn do primární větve.

   Poznámka:

   Toto počáteční nasazení může trvat několik minut. Stav nasazení můžete kdykoli zkontrolovat na webu Azure Portal nebo na kartě GitHub Actions ve vašem úložišti.

5. Na webu Azure Portal přejděte do nové statické webové aplikace.

6. V části Základy přejděte pomocí hypertextového odkazu url na spuštěnou webovou aplikaci. Ověřte, že aplikace běží podle očekávání.

Přidání konfiguračního souboru DAB

Teď pomocí rozhraní příkazového řádku DAB a SWA vytvořte nový konfigurační soubor DAB a přidejte ho do úložiště webové aplikace.

1. Otevřete úložiště GitHub pro webovou aplikaci v integrovaném vývojovém prostředí (IDE) podle vašeho výběru.

   Návod

   Můžete použít libovolné integrované vývojové prostředí( IDE), které chcete. Pokud chcete pracovat na aplikaci místně, můžete úložiště naklonovat do místního počítače. Pokud chcete pracovat v prohlížeči, můžete použít GitHub Codespaces. Ujistěte se, že jsou ve vašem vývojovém prostředí nainstalované rozhraní CLI SWA a DAB.

2. Otevřete terminál v kořenovém adresáři úložiště.

3. swa db Pomocí příkazu z rozhraní příkazového řádku SWA inicializujete nový konfigurační soubor DAB pomocí zadaného typu databáze. Příkaz vytvoří nový soubor s názvem staticwebapp.database.config.json ve složce swa-db-connections .

   swa db init --database-type "<database-type>"
   

   Důležité

   Některé typy databází budou při inicializaci vyžadovat další nastavení konfigurace.

4. dab add Pomocí příkazu přidejte do konfigurace alespoň jednu entitu databáze. Nakonfigurujte každou entitu tak, aby umožňovala všechna oprávnění anonymním uživatelům. Opakujte dab add tolikrát, kolikrát chcete pro své entity.

   dab add "<entity-name>" --source "<schema>.<table>" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"
   

5. Otevřete a zkontrolujte obsah souboru swa-db-connections/staticwebapp.database.config.json.

6. Potvrďte své změny do úložiště a pushněte je do hlavní větve. Tím se automaticky aktivuje nové nasazení webové aplikace. Než budete pokračovat podle této příručky, počkejte, až se dokončí toto nejnovější nasazení.

Konfigurace připojení k databázi

Dále nakonfigurujte připojení k databázi na webu Azure Portal, aby statická webová aplikace mohla přistupovat k databázi.

1. Na webu Azure Portal znovu přejděte do statické webové aplikace.

2. V části Nastavení nabídky prostředků vyberte možnost Připojení k databázi. Pak vyberte Propojit existující databázi pro produkční prostředí.

   

3. V dialogovém okně Propojit databázi použijte tato nastavení ke konfiguraci připojení k databázi.

   Nastavení	Hodnota
   Typ databáze	Vyberte stejný typ databáze, který jste použili při vytváření konfiguračního souboru DAB.
   skupina prostředků	Vyberte skupinu prostředků, kterou jste vytvořili dříve v této příručce.
   Název prostředku	Vyberte prostředek databáze, který chcete propojit se statickou webovou aplikací.
   Název databáze	Zadejte název databáze.
   Typ ověřování	Vyberte typ ověřování, které chcete použít.

   

   Návod

   Doporučujeme použít připojovací řetězec, který neobsahuje autorizační klíče. Místo toho použijte spravované identity a řízení přístupu na základě role ke správě přístupu mezi vaší databází a hostitelem. Další informace najdete v tématu Služby Azure, které používají spravované identity.

Testování koncového bodu rozhraní API pro data

Nakonec ověřte, že je koncový bod datového rozhraní API dostupný ve statické webové aplikaci.

1. Na webu Azure Portal znovu přejděte do statické webové aplikace.

2. Pomocí pole URL v části Základy přejděte znovu na web statické webové aplikace.

3. Přejděte na /data-api cestu pro aktuální spuštěnou aplikaci. Všimněte si, že odpověď stále značí, že kontejner DAB je v pořádku.

   { Healthy }
   

   Poznámka:

   Static Web Apps automaticky nastaví režim hostitele modulu runtime na Production, čímž přepíše libovolnou hodnotu v konfiguračním souboru. Vývojářské funkce, jako je Swagger a Banana Cake Pop, nejsou v statických webových aplikacích k dispozici.

4. Přejděte na https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> cestu pro aktuální spuštěnou aplikaci. Tento příkaz odesílá požadavek HTTP GET pro danou sadu entit. Podívejte se na odpověď JSON.

Čištění zdrojů

Pokud už ukázkovou aplikaci nebo prostředky nepotřebujete, odeberte odpovídající nasazení a všechny prostředky.

1. Pomocí webu Azure Portal přejděte do skupiny prostředků .

2. Na panelu příkazů vyberte Odstranit.