Dela via

Bygg Data API i Azure Static Web Apps (förhandsversion)

Diagram över den nuvarande placeringen ('Publicera') i sekvensen av distributionsguiden.

Hantera API-byggare för data snabbt i Azure Static Web Apps med bara en konfigurationsfil. Den här guiden innehåller steg för att integrera Data API Builder med en statisk webbapp.

I den här guiden går du igenom stegen för att skapa en DAB-konfigurationsfil, vara värd för filen som en del av ditt program och sedan använda en databasanslutning i Azure Static Web Apps.

Förutsättningar

Viktigt!

Stöd för Data API Builder (DAB) i Azure Static Web Apps med hjälp av databasanslutningar finns i förhandsversion. Azure Static Web Apps använder en fast version av DAB-motorn som kan variera från den senaste stabila versionen av DAB. Om du vill komma åt de senaste DAB-funktionerna bör du överväga en alternativ värd för DAB med den senaste versionen av motorn från GitHub, Microsoft Container Registry (Docker Hub) eller NuGet.

Skapa en statisk webbapp

Börja med att använda Azure-portalen för att skapa en ny Azure Static-webbapp med hjälp av webbprogrammet i GitHub.

  1. Logga in på Azure-portalen (https://portal.azure.com).

  2. Skapa en ny resursgrupp. Du använder den här resursgruppen för alla nya resurser i den här guiden.

    Skärmbild av sidan Skapa en resursgrupp på fliken Grundinställningar i Azure-portalen.

    Tips/Råd

    Vi rekommenderar att du namnger resursgruppen msdocs-dab-swa. Alla skärmbilder i den här guiden använder det här namnet.

  3. Skapa en Azure Static Web App. Använd de här inställningarna för att konfigurera den statiska webbappen.

    Inställning Värde
    resursgrupp Välj den resursgrupp som du skapade tidigare
    Namn Ange ett globalt unikt namn
    Typ av plan Välj det bästa alternativet för din arbetsbelastning
    Källa Välj GitHub
    GitHub-konto Konfigurera ett GitHub-konto som har åtkomst till lagringsplatsen för webbprogram
    Organisation Välj den överordnade organisationen eller användaren för lagringsplatsen
    Lagringsplats Välj lagringsplatsens namn
    Filial Välj den primära grenen

    Skärmbild av sidan

  4. Vänta tills distributionen av statiska webbprogram har slutförts. Ett GitHub Actions-arbetsflöde läggs automatiskt till på din lagringsplats som distribuerar programmet till Azure Static Web Apps varje gång du skickar till den primära grenen.

    Anmärkning

    Den här inledande distributionen kan ta några minuter. Du kan alltid kontrollera status för distributionen på azure-portalen eller på fliken GitHub Actions på lagringsplatsen.

  5. Gå till den nya statiska webbappen i Azure-portalen.

  6. I avsnittet Essentials använder du URL-hyperlänken för att navigera till webbprogrammet som körs. Kontrollera att programmet körs som förväntat.

Lägg till DAB-konfigurationsfilen

Använd nu dab- och SWA-kommandoradsgränssnitten för att skapa en ny DAB-konfigurationsfil och lägga till den i lagringsplatsen för webbprogram.

  1. Öppna GitHub-lagringsplatsen för ditt webbprogram i den integrerade utvecklarmiljö (IDE) som du väljer.

    Tips/Råd

    Du kan använda valfri IDE som du vill. Om du vill arbeta med programmet lokalt kan du klona lagringsplatsen till den lokala datorn. Om du föredrar att arbeta i webbläsaren kan du använda GitHub Codespaces. Se till att SWA- och DAB-CLI:erna är installerade i utvecklingsmiljön.

  2. Öppna en terminal i lagringsplatsens rot.

  3. swa db Använd kommandot från SWA CLI för att initiera en ny DAB-konfigurationsfil med den angivna databastypen. Kommandot skapar en ny fil med namnet staticwebapp.database.config.json i mappen swa-db-connections .

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

    Viktigt!

    Vissa databastyper kräver ytterligare konfigurationsinställningar vid initiering.

  4. dab add Använd kommandot för att lägga till minst en databasentitet i konfigurationen. Konfigurera varje entitet för att tillåta alla behörigheter för anonyma användare. Upprepa dab add så många gånger du vill för dina entiteter.

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

  5. Öppna och granska innehållet i filen swa-db-connections/staticwebapp.database.config.json.

  6. Checka in ändringarna på lagringsplatsen och skicka dem till den primära grenen. Detta utlöser automatiskt en ny distribution av webbprogrammet. Vänta tills den senaste distributionen har slutförts innan du fortsätter med den här guiden.

Konfigurera databasanslutningen

Konfigurera sedan databasanslutningen i Azure-portalen så att den statiska webbappen kan komma åt databasen.

  1. Gå till den statiska webbappen igen i Azure-portalen.

  2. Välj alternativet Databasanslutning i avsnittet Inställningar på resursmenyn. Välj sedan Länka befintlig databas för produktionsmiljön .

    Skärmbild av alternativet Databasanslutning på sidan Azure Static Web Apps i Azure-portalen.

  3. I dialogrutan Länka databas använder du de här inställningarna för att konfigurera databasanslutningen.

    Inställning Värde
    Databastyp Välj samma databastyp som du använde när du skapade DAB-konfigurationsfilen
    resursgrupp Välj den resursgrupp som du skapade tidigare i den här guiden
    Resursnamn Välj den databasresurs som du vill länka till den statiska webbappen
    Databasnamn Ange namnet på databasen
    Autentiseringstyp Välj den typ av autentisering som du tänker använda

    Skärmbild av dialogrutan Länkdatabas för databasanslutningar på sidan Azure Static Web Apps i Azure-portalen.

    Tips/Råd

    Vi rekommenderar att du använder en anslutningssträng som inte innehåller auktoriseringsnycklar. Använd i stället hanterade identiteter och rollbaserad åtkomstkontroll för att hantera åtkomst mellan din databas och värd. Mer information finns i Azure-tjänster som använder hanterade identiteter.

Testa data-API-slutpunkten

Kontrollera slutligen att data-API-slutpunkten är tillgänglig i den statiska webbappen.

  1. Gå till den statiska webbappen igen i Azure-portalen.

  2. Använd URL-fältet i avsnittet Essentials för att bläddra till den statiska webbappens webbplats igen.

  3. Navigera till /data-api-sökvägen för det aktuella körande programmet. Observera att svaret fortfarande anger att DAB-containern är felfri.

    { Healthy }

    Anmärkning

    Static Web Apps ställer automatiskt in körvärdens läge på Production och skriver över alla värden i konfigurationsfilen. Därför är utvecklarfunktioner som Swagger och Banana Cake Pop inte tillgängliga i Static Web Apps.

  4. Navigera till https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name>-sökvägen för det aktuella körande programmet. Detta utfärdar en HTTP GET-begäran för den uppsättningen entiteter. Observera JSON-svaret.

Rensa resurser

När du inte längre behöver exempelprogrammet eller resurserna tar du bort motsvarande distribution och alla resurser.

  1. Navigera till resursgruppen med hjälp av Azure-portalen.

  2. I kommandofältet väljer du Ta bort.