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

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żne

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 silnika DAB, która może różnić się od najnowszej stabilnej wersji DAB. Aby uzyskać dostęp do najnowszych funkcji DAB, rozważ użycie alternatywnego hosta dla DAB przy użyciu najnowszej wersji silnika z GitHub, platformy Microsoft Container Registry (Docker Hub) lub narzędzia NuGet.

• Konto Azure z aktywną subskrypcją. Utwórz konto bezpłatnie.
• Interfejs wiersza polecenia usługi Azure Static Web Apps. Zainstaluj CLI dla Static Web Apps (SWA).
• Kreator interfejsu wiersza polecenia do API danych. Zainstaluj narzędzie CLI Data API Builder (DAB).
• Istniejąca obsługiwana baza danych dostępna z poziomu platformy Azure.
• Istniejąca aplikacja internetowa w repozytorium GitHub, które można wdrożyć w usłudze Azure Static Web Apps.
  • Jeśli nie masz aplikacji internetowej, wygeneruj repozytorium przy użyciu podstawowej aplikacji internetowej.

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.

   

   Wskazówka

   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ą.

   Ustawienia	Wartość
   grupa zasobów	Wybierz utworzoną wcześniej grupę zasobów
   nazwa	Wprowadź globalnie unikatową nazwę
   Typ planu	Wybierz najlepszą opcję dla obciążenia
   Źródło	Wybierz pozycję GitHub
   Konto GitHub	Konfigurowanie konta usługi GitHub, które ma dostęp do repozytorium aplikacji internetowej
   Organizacja	Wybierz organizację nadrzędną lub użytkownika dla repozytorium
   Repozytorium	Wybierz nazwę repozytorium
   Gałąź	Wybierz gałąź podstawową

   

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.

   Uwaga / Notatka

   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 Podstawy 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).

   Wskazówka

   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 poleceń SWA, aby zainicjować nowy plik konfiguracji 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żne

   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. Powtarzaj 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 prześlij je do gałęzi głównej. Spowoduje to automatyczne uruchomienie 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 menu zasobu. Następnie wybierz pozycję Połącz istniejącą bazę danych dla środowiska produkcyjnego .

   

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

   Ustawienia	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
   Authentication type (Typ uwierzytelniania)	Wybierz typ uwierzytelniania, którego chcesz użyć

   

   Wskazówka

   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ługi platformy Azure korzystające 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 Adres URL w sekcji Podstawy , aby ponownie przejść do witryny internetowej statycznej aplikacji internetowej.

3. Przejdź do ścieżki /data-api aplikacji, która jest obecnie uruchomiona. Zwróć uwagę, że odpowiedź nadal wskazuje, że kontener DAB jest w dobrej kondycji.

   { Healthy }
   

   Uwaga / Notatka

   Usługa Static Web Apps automatycznie ustawia tryb hosta środowiska uruchomieniowego na Production, zastępując dowolną wartość w pliku konfiguracji. W związku z tym funkcje deweloperów, takie jak Swagger i Banana Cake Pop, są niedostępne w usłudze Static Web Apps.

4. Przejdź do ścieżki https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> aplikacji, która jest obecnie uruchomiona. Powoduje to wysłanie żądania HTTP GET dla tego zestawu jednostek. Obserwuj odpowiedź JSON.

Uprzątnij zasoby

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ń.