Redigera

Dela via


Värd för API-byggare för data i Azure Static Web Apps (förhandsversion)

diagram över den aktuella platsen (

Diagram över sekvensen i distributionsguiden, inklusive dessa platser, i ordning: Översikt, Planera, Förbereda, Publicera, Övervaka och Optimering. Platsen Publicera är för närvarande markerad.

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

Viktig

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.

  • Befintlig databas som stöds kan adresseras från Azure.

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 till för alla nya resurser i den här guiden.

    Skärmbild av fliken

    Dricks

    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
    Plantyp 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
    Branch Välj den primära grenen

    Skärmbild av fliken

  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.

    Not

    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 hyperlänken URL 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.

    Dricks

    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. Använd kommandot swa db 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>"
    

    Viktig

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

  4. Använd kommandot dab add 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 i resursmenyn. Välj sedan Länka befintlig databas för produktionsmiljö.

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

  3. I dialogrutan Link-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.

    Dricks

    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 fältet URL i avsnittet Essentials för att bläddra till den statiska webbappens webbplats igen.

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

    { Healthy }
    
  4. Navigera till den https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> sökvägen för det aktuella program som körs. 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. Gå till den resursgruppen med hjälp av Azure-portalen.

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