Vývoj datového rozhraní API pomocí Azure Static Web Apps

Dokončeno

Statické webové aplikace jsou konceptem návrhu webu, který se stal populárním. Skládají se z obsahu odeslaného přímo do prohlížeče uživatele, který nevyžaduje spuštění kódu na serveru. Statické webové aplikace se skládají z HTML a CSS. Často také obsahují javascriptový kód, který se spouští na straně klienta, nikoli na serveru. Weboví vývojáři často najdou statické webové aplikace:

  • Lze rychle vyvíjet pomocí architektur, jako jsou Bootstrap, Jekyll a AngularJS.
  • Škálování je jednoduché, protože na serveru se nemění žádný stav.
  • Povzbuďte oddělení mezi kódem uživatelského rozhraní a back-endovými funkcemi.

Azure Static Web Apps je služba v Azure navržená tak, aby usnadnila kódování a nasazení statických webových aplikací do Azure pro produkční prostředí. Azure Static Web Apps podporuje průběžné nasazování monitorováním úložiště kódu na GitHubu nebo Azure DevOps. Když provedete změnu kódu webu a odešlete změnu do úložiště, Azure Static Web Apps změnu automaticky sestaví a nasadí nový web do Azure. Okamžitě se vaše změna zpřístupní uživatelům.

Diagram znázorňující, jak Azure Static Web Apps usnadňuje nasazení statických webových aplikací z úložišť

Vzhledem k tomu, že Tvůrce rozhraní DATA API (DAB) je navržený tak, aby bezproblémově fungoval se službou Azure Static Web Apps, je jednoduché hostovat rozhraní API databáze v této službě. Stačí, když pomocí konfiguračního souboru řeknete DAB o vaší instanci Azure Static Web Apps a nasadíte ji do úložiště. Azure Static Web Apps bude hostovat vaše rozhraní API a uživatelé můžou začít volat své metody.

Vytvoření statické webové aplikace

Začněte tím, že přejdete na web Azure Portal a vyberete Vytvořit prostředek. Na panelu hledání zadejte statickou webovou aplikaci. Jakmile se zobrazí karta Static Web App , vyberte ji a pak vyberte Vytvořit.

Pak zvolte své předplatné a vyberte existující skupinu prostředků nebo vytvořte novou. Do textového pole Název zadejte popisný název aplikace. Musíte vybrat typ plánu. Pro osobní projekty můžete použít plán Free , zatímco pro produkční aplikace se doporučuje plán Standard .

Snímek obrazovky znázorňující, jak průvodce dokončit a vytvořit statickou webovou aplikaci na webu Azure Portal

V části Podrobnosti o nasazení zadejte typ úložiště, které obsahuje vaši aplikaci. Musíte se přihlásit k GitHubu nebo vybrat úložiště a větev v Azure DevOps. Nakonec zkontrolujte nastavení tak , že vyberete Zkontrolovat a vytvořit a pak proces dokončíte výběrem možnosti Vytvořit .

Vytvoření konfiguračního souboru tvůrce rozhraní Data API

Pokud chcete nasadit rozhraní API databáze do Azure Static Web Apps, musíte správně vytvořit konfigurační soubor DAB. Tuto úlohu můžete dokončit pomocí dvou nástrojů příkazového řádku:

  • swa: Pomocí tohoto rozhraní příkazového řádku inicializujete nový konfigurační soubor DAB.
  • dab: Pomocí tohoto rozhraní příkazového řádku přidejte do souboru jednu nebo více databází.

Než začnete, buď naklonujte úložiště GitHub do místního počítače, nebo pomocí GitHub Codespaces otevřete příkazový řádek v samotném GitHubu.

  1. Pokud chcete inicializovat konfigurační soubor DAB v kořenové složce úložiště, spusťte následující příkaz.

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

    Nahraďte <database type> databázovým serverem. Pokud je například vaše databáze hostovaná ve službě Azure SQL Database, použijte mssql. Pokud je v MySQL, použijte mysql.

  2. Pokud chcete do konfiguračního souboru přidat databázi, spusťte následující příkaz.

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

    Nahraďte <database-name> popisným názvem a <schema>.<table> názvem schématu a tabulky v databázi.

Tento postup vytvoří konfigurační soubor v úložišti s názvem swa-db-connections/staticwebapp.database.config.json. Před potvrzením změn do úložiště zkontrolujte tento soubor.

Konfigurace připojení k databázi

Pokud chcete nakonfigurovat připojení k databázi ve statické webové aplikaci, začněte otevřením statické webové aplikace na webu Azure Portal. Přejděte do části Nastavení a vyberte Připojení k databázi. V části Produkční zvolte propojení existující databáze. Vyberte odpovídající typ databáze, skupinu prostředků a název databáze. Nakonec zvolte upřednostňovaný typ ověřování a propojte databázi.

Poznámka:

K ověření doporučujeme použít spravovanou identitu přiřazenou systémem nebo spravovanou identitu přiřazenou uživatelem, protože připojovací řetězec neobsahuje autorizační klíč.

Ověření přístupu k rozhraní API

Pokud chcete ověřit přístup k rozhraní API, začněte otevřením statické webové aplikace, kterou jste vytvořili na webu Azure Portal. Přejděte do části Základy a vyberte adresu URL pro procházení webu. Na panelu Adresa prohlížeče přidejte /data-api adresu URL a stiskněte Enter.

Měla by se zobrazit stránka označující, že kontejner DAB je v pořádku. Pokud chcete procházet entity z databáze, připojte /data-api/rest/ se k adrese URL. Tím se odešle požadavek HTTP GET a zobrazí se odpověď JSON.