Hostowanie konstruktora interfejsu API danych w usłudze Azure Static Web Apps (wersja zapoznawcza)

Diagram bieżącej lokalizacji ('Publish') w sekwencji przewodnika wdrażania.

Diagram sekwencji przewodnika wdrażania, w tym tych lokalizacji, w kolejności: Przegląd, Planowanie, Przygotowywanie, Publikowanie, Monitorowanie i Optymalizacja. Lokalizacja "Publikuj" jest obecnie wyróżniona.

Szybkie hostowanie konstruktora interfejsu API danych w usłudze Azure Static Web Apps przy użyciu tylko pliku konfiguracji. Ten przewodnik zawiera kroki integracji konstruktora interfejsu API danych z statyczną aplikacją internetową.

W tym przewodniku przedstawiono kroki tworzenia pliku konfiguracji języka DAB, hostowania pliku w ramach aplikacji, a następnie używania połączenia bazy danych w usłudze Azure Static Web Apps.

Wymagania wstępne

Ważny

Obsługa konstruktora interfejsu API danych (DAB) w usłudze Azure Static Web Apps przy użyciu połączeń bazy danych jest dostępna w wersji zapoznawczej. Usługa Azure Static Web Apps używa stałej wersji aparatu DAB, która może różnić się od najnowszej stabilnej wersji języka DAB. Aby uzyskać dostęp do najnowszych funkcji języka DAB, rozważ alternatywny host języka DAB przy użyciu najnowszej wersji aparatu z usługi GitHub, usługi Microsoft Container Registry (Docker Hub) lub narzędzia NuGet.

  • Istniejąca obsługiwana baza danych z platformy Azure.

Tworzenie statycznej aplikacji internetowej

Aby rozpocząć, użyj witryny Azure Portal, aby utworzyć nową statyczną aplikację internetową Platformy Azure przy użyciu aplikacji internetowej w usłudze GitHub.

  1. Zaloguj się do witryny Azure Portal (https://portal.azure.com).

  2. Utwórz nową grupę zasobów. Ta grupa zasobów będzie używana do obsługi wszystkich nowych zasobów w tym przewodniku.

    Zrzut ekranu przedstawiający kartę

    Napiwek

    Zalecamy nadanie grupie zasobów nazwy msdocs-dab-swa. Wszystkie zrzuty ekranu w tym przewodniku używają tej nazwy.

  3. Tworzenie statycznej aplikacji internetowej platformy Azure. Użyj tych ustawień, aby skonfigurować statyczną aplikację internetową.

    Ustawienie Wartość
    grupa zasobów Wybierz utworzoną wcześniej grupę zasobów
    nazwa Wprowadź globalnie unikatową nazwę
    typ planu Wybierz najlepszą opcję dla obciążenia
    source Wybieranie usługi GitHub
    konta usługi GitHub Konfigurowanie konta usługi GitHub, które ma dostęp do repozytorium aplikacji internetowej
    organizacji Wybierz organizację nadrzędną lub użytkownika dla repozytorium
    repozytorium Wybierz nazwę repozytorium
    Branch Wybierz gałąź podstawową

    Zrzut ekranu przedstawiający kartę

  4. Poczekaj na zakończenie wdrożenia statycznej aplikacji internetowej. Przepływ pracy funkcji GitHub Actions jest automatycznie dodawany do repozytorium, który będzie wdrażać aplikację w usłudze Azure Static Web Apps za każdym razem, gdy wypchniesz do gałęzi podstawowej.

    Nuta

    To początkowe wdrożenie może potrwać kilka minut. Stan wdrożenia można zawsze sprawdzić w witrynie Azure Portal lub na karcie GitHub Actions w repozytorium.

  5. Przejdź do nowej statycznej aplikacji internetowej w witrynie Azure Portal.

  6. W sekcji Essentials użyj hiperlinku adresu URL , aby przejść do uruchomionej aplikacji internetowej. Sprawdź, czy aplikacja działa zgodnie z oczekiwaniami.

Dodawanie pliku konfiguracji języka DAB

Teraz użyj interfejsów wiersza polecenia DAB i SWA, aby utworzyć nowy plik konfiguracji daB i dodać go do repozytorium aplikacji internetowej.

  1. Otwórz repozytorium GitHub dla swojej aplikacji internetowej w wybranym środowisku deweloperskim (IDE).

    Napiwek

    Możesz użyć dowolnego środowiska IDE. Jeśli chcesz pracować nad aplikacją lokalnie, możesz sklonować repozytorium na komputer lokalny. Jeśli wolisz pracować w przeglądarce, możesz użyć usługi GitHub Codespaces. Upewnij się, że w środowisku projektowym zainstalowano interfejsy CLI swa i DAB.

  2. Otwórz terminal w katalogu głównym repozytorium.

  3. Użyj polecenia swa db z interfejsu wiersza polecenia programu SWA, aby zainicjować nowy plik konfiguracji języka DAB przy użyciu określonego typu bazy danych. Polecenie utworzy nowy plik o nazwie staticwebapp.database.config.json w folderze swa-db-connections.

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

    Ważny

    Niektóre typy baz danych będą wymagać dodatkowych ustawień konfiguracji podczas inicjowania.

  4. Użyj polecenia dab add, aby dodać do konfiguracji co najmniej jedną jednostkę bazy danych. Skonfiguruj każdą jednostkę, aby zezwolić na wszystkie uprawnienia dla użytkowników anonimowych. Powtórz dab add tyle razy, ile chcesz dla jednostek.

    dab add "<entity-name>" --source "<schema>.<table>" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"
    
  5. Otwórz i przejrzyj zawartość pliku swa-db-connections/staticwebapp.database.config.json.

  6. Zatwierdź zmiany w repozytorium i wypchnij je do gałęzi podstawowej. Spowoduje to automatyczne wyzwolenie nowego wdrożenia aplikacji internetowej. Przed kontynuowaniem pracy z tym przewodnikiem poczekaj na zakończenie tego najnowszego wdrożenia.

Konfigurowanie połączenia z bazą danych

Następnie skonfiguruj połączenie bazy danych w witrynie Azure Portal, aby zezwolić statycznej aplikacji internetowej na dostęp do bazy danych.

  1. Przejdź ponownie do statycznej aplikacji internetowej w witrynie Azure Portal.

  2. Wybierz opcję połączenie z bazą danych w sekcji Ustawienia w menu zasobów. Następnie wybierz pozycję Połącz istniejącą bazę danych dla środowiska produkcyjnego .

    Zrzut ekranu przedstawiający opcję

  3. W oknie dialogowym Połącz bazę danych użyj tych ustawień, aby skonfigurować połączenie z bazą danych.

    Ustawienie Wartość
    Typ bazy danych Wybierz ten sam typ bazy danych, który został użyty podczas tworzenia pliku konfiguracji języka DAB
    grupa zasobów Wybierz grupę zasobów utworzoną wcześniej w tym przewodniku
    nazwa zasobu Wybierz zasób bazy danych, który chcesz połączyć ze statyczną aplikacją internetową
    Nazwa bazy danych Wprowadź nazwę bazy danych
    typ uwierzytelniania Wybierz typ uwierzytelniania, którego chcesz użyć

    Zrzut ekranu przedstawiający okno dialogowe

    Napiwek

    Zalecamy używanie parametrów połączenia, które nie zawierają kluczy autoryzacji. Zamiast tego użyj tożsamości zarządzanych i kontroli dostępu opartej na rolach, aby zarządzać dostępem między bazą danych i hostem. Aby uzyskać więcej informacji, zobacz usług platformy Azure korzystających z tożsamości zarządzanych.

Testowanie punktu końcowego interfejsu API danych

Na koniec sprawdź, czy punkt końcowy interfejsu API danych jest dostępny w statycznej aplikacji internetowej.

  1. Przejdź ponownie do statycznej aplikacji internetowej w witrynie Azure Portal.

  2. Użyj pola URL w sekcji Essentials, aby ponownie przejść do statycznej witryny internetowej aplikacji internetowej.

  3. Przejdź do ścieżki /data-api dla bieżącej uruchomionej aplikacji. Zauważ, że odpowiedź nadal wskazuje, że kontener DAB jest w dobrej kondycji.

    { Healthy }
    
  4. Przejdź do ścieżki https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> dla bieżącej uruchomionej aplikacji. Powoduje to żądanie HTTP GET dla tego zestawu jednostek. Obserwuj odpowiedź JSON.

Czyszczenie zasobów

Jeśli nie potrzebujesz już przykładowej aplikacji lub zasobów, usuń odpowiednie wdrożenie i wszystkie zasoby.

  1. Przejdź do grupy zasobów przy użyciu witryny Azure Portal.

  2. Na pasku poleceń wybierz pozycję Usuń.