Host Data API Builder in Azure Static Web Apps (előzetes verzió)

Az üzembe helyezési útmutató sorrendjének diagramja a következő helyekkel együtt: Áttekintés, Tervezés, Előkészítés, Közzététel, Figyelés és Optimalizálás. Jelenleg a "Közzététel" helyszín van kiemelve.

Az Azure Static Web Appsben gyorsan üzemeltetheti a Data API Buildert egy konfigurációs fájl használatával. Ez az útmutató a Data API Builder statikus webalkalmazásokkal való integrálásának lépéseit tartalmazza.

Ebben az útmutatóban végigvezetheti a DAB-konfigurációs fájl készítésének lépéseit, az alkalmazás részeként üzemeltetheti a fájlt, majd adatbázis-kapcsolatot használhat az Azure Static Web Appsben.

Előfeltételek

Fontos

A Data API Builder (DAB) adatbázis-kapcsolatok használatával történő támogatása az Azure Static Web Appsben előzetes verzióban érhető el. Az Azure Static Web Apps a DAB motor rögzített verzióját használja, amely a DAB legújabb stabil verziójától eltérő lehet. A legújabb DAB-funkciók eléréséhez fontolja meg a DAB alternatív kiszolgálójának használatát a motor legújabb verziójának használatával, amely letölthető a GitHubról, a Microsoft Container Registryből (Docker Hub) vagy a NuGetből.

• Egy Azure-fiók, aktív előfizetéssel. Fiók létrehozása ingyenes.
• Azure Static Web Apps CLI. Telepítse a Static Web Apps (SWA) parancssori felületét.
• Adat API-építő CLI. Telepítse a Data API Builder (DAB) parancssori felületét.
• Meglévő, az Azure-ból címezhető támogatott adatbázis.
• Meglévő webalkalmazás egy GitHub-adattárban, amely üzembe helyezhető az Azure Static Web Appsben.
  • Ha nem rendelkezik webalkalmazással, hozzon létre egy adattárat egy alapszintű webalkalmazással.

Statikus webalkalmazás létrehozása

Első lépésként az Azure Portal használatával hozzon létre egy új Azure Static Web Appot a GitHub webalkalmazásával.

1. Jelentkezzen be az Azure Portalra (https://portal.azure.com).

2. Új erőforráscsoport létrehozása. Ebben az útmutatóban ezt az erőforráscsoportot fogja használni az összes új erőforráshoz.

   

   Jótanács

   Javasoljuk az msdocs-dab-swa erőforráscsoport elnevezését. Az útmutató összes képernyőképe ezt a nevet használja.

3. Azure Static Web App létrehozása. Ezekkel a beállításokkal konfigurálhatja a statikus webalkalmazást.

   Beállítás	Érték
   Erőforráscsoport	Válassza ki a korábban létrehozott erőforráscsoportot
   Név	Globálisan egyedi név megadása
   Terv típusa	Válassza ki a számítási feladathoz legmegfelelőbb lehetőséget
   Forrás	A GitHub kiválasztása
   GitHub-fiók	A webalkalmazás-adattárhoz hozzáféréssel rendelkező GitHub-fiók konfigurálása
   Szervezet	Válassza ki az adattár szülőszervezetét vagy felhasználóját
   Adattár	Válassza ki az adattár nevét
   Fiók	Válassza ki az elsődleges ágat

   

4. Várja meg, amíg a statikus webalkalmazás üzembe helyezése befejeződik. Egy GitHub Actions munkafolyamat automatikusan hozzáadódik a tárházadhoz, amely minden alkalommal üzembe helyezi az alkalmazást az Azure Static Web Appsre, amikor a fő ágra küldesz változtatásokat.

   Megjegyzés:

   Ez a kezdeti üzembe helyezés eltarthat néhány percig. Az üzembe helyezés állapotát bármikor ellenőrizheti az Azure Portalon vagy az adattár GitHub Actions lapján.

5. Lépjen az új statikus webalkalmazásra az Azure Portalon.

6. Az Essentials szakaszban az URL-hivatkozással keresse meg a futó webalkalmazást. Ellenőrizze, hogy az alkalmazás a várt módon fut-e.

A DAB konfigurációs fájljának hozzáadása

Most a DAB és az SWA parancssori felületével hozzon létre egy új DAB-konfigurációs fájlt, és adja hozzá a webalkalmazás-adattárhoz.

1. Nyissa meg a webalkalmazáshoz tartozó GitHub-adattárat a választott integrált fejlesztői környezetben (IDE).

   Jótanács

   Bármilyen IDE-t használhat. Ha helyileg szeretne dolgozni az alkalmazáson, klónozhatja az adattárat a helyi gépére. Ha inkább a böngészőben szeretne dolgozni, használhatja a GitHub Codespacest. Győződjön meg arról, hogy az SWA és a DAB CLI telepítve van a fejlesztői környezetben.

2. Nyisson meg egy terminált az adattár gyökerében.

3. swa db Az SWA CLI parancsával inicializálhat egy új DAB-konfigurációs fájlt a megadott adatbázistípussal. A parancs létrehoz egy staticwebapp.database.config.json nevű új fájlt a swa-db-connections mappában.

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

   Fontos

   Egyes adatbázistípusokhoz további konfigurációs beállításokra lesz szükség az inicializáláshoz.

4. dab add A parancs használatával adjon hozzá legalább egy adatbázis-entitást a konfigurációhoz. Konfigurálja az egyes entitásokat úgy, hogy engedélyezve legyen a névtelen felhasználók összes engedélye. Ismételje meg dab add annyiszor, amennyit csak szeretne az entitások esetében.

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

5. Nyissa meg és tekintse át a swa-db-connections/staticwebapp.database.config.json fájl tartalmát.

6. Véglegesítse a módosításokat az adattárban, és küldje el őket az elsődleges ágba. Ez automatikusan elindítja a webalkalmazás új üzembe helyezését. Várja meg, amíg ez a legújabb üzembe helyezés befejeződik, mielőtt folytatná ezt az útmutatót.

Az adatbázis-kapcsolat konfigurálása

Ezután konfigurálja az adatbázis-kapcsolatot az Azure Portalon, hogy a statikus webalkalmazás hozzáférjen az adatbázishoz.

1. Lépjen ismét a statikus webalkalmazásra az Azure Portalon.

2. Válassza az Adatbázis-kapcsolat lehetőséget az erőforrás menü Beállítások szakaszában. Ezután válassza a Meglévő adatbázis csatolása az éles környezethez lehetőséget.

   

3. Az Adatbázis csatolása párbeszédpanelen ezekkel a beállításokkal konfigurálhatja az adatbázis-kapcsolatot.

   Beállítás	Érték
   adatbázistípus	Válassza ki ugyanazt az adatbázistípust, amelyet a DAB-konfigurációs fájl létrehozásakor használt
   Erőforráscsoport	Válassza ki az útmutatóban korábban létrehozott erőforráscsoportot
   Erőforrás neve	Válassza ki a statikus webalkalmazáshoz csatolni kívánt adatbázis-erőforrást
   Adatbázis neve	Adja meg az adatbázis nevét
   Hitelesítés típusa	Válassza ki a használni kívánt hitelesítés típusát

   

   Jótanács

   Javasoljuk, hogy olyan kapcsolati sztringet használjon, amely nem tartalmaz engedélyezési kulcsokat. Ehelyett használjon felügyelt identitásokat és szerepköralapú hozzáférés-vezérlést az adatbázis és a gazdagép közötti hozzáférés kezeléséhez. További információt a felügyelt identitásokat használó Azure-szolgáltatásokban talál.

Az adat API-végpont tesztelése

Végül ellenőrizze, hogy az adat API-végpont elérhető-e a statikus webalkalmazásban.

1. Lépjen ismét a statikus webalkalmazásra az Azure Portalon.

2. Az Alapvető beállítások szakaszban található URL-mezővel keresse meg újra a statikus webalkalmazás webhelyét.

3. Keresse meg az /data-api aktuális futó alkalmazás elérési útját. Figyelje meg, hogy a válasz továbbra is azt jelzi, hogy a DAB-tároló kifogástalan állapotú.

   { Healthy }
   

   Megjegyzés:

   A Static Web Apps automatikusan beállítja a futtatókörnyezet gazdagép üzemmódját Production, felülírva a konfigurációs fájl bármely értékét. Ennek eredményeképpen az olyan fejlesztői funkciók, mint a Swagger és a Banana Cake Pop, nem érhetők el a Static Web Appsben.

4. Keresse meg az https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> aktuális futó alkalmazás elérési útját. Ez egy HTTP GET-kérést ad ki az adott entitáskészlethez. Figyelje meg a JSON-választ.

Erőforrások tisztítása

Ha már nincs szüksége a mintaalkalmazásra vagy erőforrásokra, távolítsa el a megfelelő üzembe helyezést és az összes erőforrást.

1. Lépjen az erőforráscsoportra az Azure Portalon.

2. A parancssávon válassza a Törlés lehetőséget.