Megosztás a következőn keresztül:

AZ API-portál használata a VMware Tanzu-hoz

  • Cikk

Feljegyzés

Az Azure Spring Apps az Azure Spring Cloud szolgáltatás új neve. Bár a szolgáltatásnak új neve van, bizonyos helyeken a régi nevet fogja látni egy darabig, miközben az eszközök, például képernyőképek, videók és diagramok frissítésével dolgozunk.

Ez a cikk a következőre vonatkozik:❌ Basic/Standard ✔️ Enterprise

Ez a cikk bemutatja, hogyan használhatja az API Portalt a VMware Tanzu-hoz az Azure Spring Apps Enterprise-csomaggal.

Az API Portal az egyik kereskedelmi VMware Tanzu-összetevő. Az API Portal támogatja a Spring Cloud Gateway API-definícióinak megtekintését a VMware Tanzu-hoz , valamint a böngészőből származó adott API-útvonalak tesztelését. Emellett támogatja az egyszeri bejelentkezés (SSO) hitelesítésének engedélyezését konfiguráción keresztül.

Előfeltételek

Egyszeri bejelentkezés (SSO) konfigurálása

Az API Portal az OpenID Csatlakozás Discovery protokollt támogató OpenID-identitásszolgáltatóval (IdP) támogatja az egyszeri bejelentkezés (SSO) használatával történő hitelesítést és engedélyezést.

Feljegyzés

Csak az OpenID Csatlakozás Discovery protokollt támogató engedélyezési kiszolgálók támogatottak. Ügyeljen arra, hogy a külső engedélyezési kiszolgálót úgy konfigurálja, hogy az átirányítások visszakerüljenek az API-portálra. Tekintse meg az engedélyezési kiszolgáló dokumentációját, és vegye fel https://<api-portal-external-url>/login/oauth2/code/sso az engedélyezett átirányítási URI-k listájára.

Tulajdonság Kötelező? Leírás
issuerUri Igen Az alkalmazás által kiállítóazonosítóként érvényes URI. Ha például a megadott kiállító-uri "https://example.com", akkor a rendszer egy OpenID-szolgáltató konfigurációs kérést küld a következőhöz: "https://example.com/.well-known/openid-configuration". Az eredmény várhatóan egy OpenID-szolgáltató konfigurációs válasza lesz.
clientId Igen Az Identitásszolgáltató által megadott OpenID Csatlakozás ügyfélazonosító
clientSecret Igen Az OpenID Csatlakozás ügyfélkód, amelyet az idP biztosít
hatálya Igen A JWT-identitásjogkivonatokban szerepeltetni kívánt hatókörök listája. Ennek a listának az identitásszolgáltató által engedélyezett hatókörökön kell alapulnia

Az egyszeri bejelentkezés Microsoft Entra-azonosítóval való beállításáról a Spring Cloud Gatewayhez készült Microsoft Entra ID-val és a Tanzu api Portaljával való egyszeri bejelentkezésről szóló cikkben olvashat.

Feljegyzés

Ha helytelen SSO-tulajdonságot konfigurál, például rossz jelszót, távolítsa el a teljes egyszeri bejelentkezés tulajdonságot, és adja hozzá újra a megfelelő konfigurációt.

A példányszám konfigurálása

A példányszám API Portalon való konfigurálásához kövesse az alábbi lépéseket:

  1. Lépjen a szolgáltatáspéldányra, és válassza az API Portalt.
  2. Válassza a Felskálázás lehetőséget.
  3. Konfigurálja a példányok számát, majd válassza a Mentés lehetőséget.

Nyilvános végpont hozzárendelése az API Portalhoz

A következő lépésekkel rendelhet hozzá nyilvános végpontot az API Portalhoz:

  1. Válassza az API Portalt.
  2. Válassza az Áttekintés lehetőséget az API Portalhoz lefoglalt futó állapot és erőforrások megtekintéséhez.
  3. A nyilvános végpont hozzárendeléséhez válassza a Végpont hozzárendelése mellett az Igen lehetőséget. A rendszer néhány percen belül létrehoz egy URL-címet.
  4. Mentse az URL-címet későbbi használatra.

Az API kipróbálás funkciójának konfigurálása

Az API Portalon központilag tekintheti meg az API-kat, és kipróbálhatja őket az API kipróbálás funkciójával. Az API-kipróbálás alapértelmezés szerint engedélyezve van, és ez a konfiguráció segít kikapcsolni a teljes API Portal-példányon. További információkért tekintse meg az API Portal kipróbálása api-kkal foglalkozó szakaszát.

Az API kipróbálásának engedélyezéséhez vagy letiltásához kövesse az alábbi lépéseket:

  1. Lépjen a szolgáltatáspéldányra, és válassza az API Portalt.
  2. Válassza a Konfiguráció lehetőséget.
  3. Válassza az API kipróbálás engedélyezése lehetőséget, vagy törölje belőle a jelet, majd válassza a Mentés lehetőséget.

API-útválasztás konfigurálása OpenAPI-specifikációval a Tanzu-hoz készült Spring Cloud Gatewayen

Ez a szakasz azt ismerteti, hogyan tekintheti meg és kipróbálhatja az API-kat sémadefiníciókkal az API Portalon. Az alábbi lépésekkel konfigurálhatja az API-útválasztást egy OpenAPI-specifikációs URL-címmel a Tanzu-hoz készült Spring Cloud Gatewayen.

  1. Hozzon létre egy alkalmazást az Azure Spring Appsben, amelybe az átjáró átirányítja a forgalmat.

  2. Hozza létre az OpenAPI-definíciót, és kérje le az URI-t a hozzáféréshez. A rendszer a következő két URI-lehetőséget fogadja el:

    • Az első lehetőség egy nyilvánosan elérhető végpont, például az URI https://petstore3.swagger.io/api/v3/openapi.jsonhasználata, amely tartalmazza az OpenAPI-specifikációt.
    • A második lehetőség az, hogy az OpenAPI-definíciót az alkalmazás relatív elérési útjára helyezi az Azure Spring Appsben, és az URI-t a formátumban http://<app-name>/<relative-path-to-OpenAPI-spec>hozza létre. Választhat olyan eszközöket, mint SpringDocs az OpenAPI-specifikáció automatikus létrehozása, így az URI hasonló lehet http://<app-name>/v3/api-docs.

  3. A következő paranccsal rendeljen hozzá egy nyilvános végpontot az átjáróhoz a hozzáféréshez.

    az spring gateway update --assign-endpoint

  4. A Spring Cloud Gateway tanzu-tulajdonságokhoz való konfigurálásához használja a következő parancsot:

    az spring gateway update \
    --api-description "<api-description>" \
    --api-title "<api-title>" \
    --api-version "v0.1" \
    --server-url "<endpoint-in-the-previous-step>" \
    --allowed-origins "*"

  5. Útválasztási szabályok konfigurálása alkalmazásokhoz.

    Ha szabályokat szeretne létrehozni az alkalmazás eléréséhez a Spring Cloud Gateway for Tanzu útvonalkonfigurációjában, mentse a következő tartalmat a sample.json fájlba.

    {
   "open_api": {
      "uri": "https://petstore3.swagger.io/api/v3/openapi.json"
   },
   "routes": [
      {
         "title": "Petstore",
         "description": "Route to application",
         "predicates": [
            "Path=/pet",
            "Method=PUT"
         ],
         "filters": [
            "StripPrefix=0"
         ]
      }
   ]
}

    Az open_api.uri érték a fenti második lépésben létrehozott nyilvános végpont vagy URI. Az OpenAPI-specifikációban meghatározott elérési utakhoz predikátumokat és szűrőket adhat hozzá.

    A következő paranccsal alkalmazza a szabályt az első lépésben létrehozott alkalmazásra:

    az spring gateway route-config create \
    --name sample \
    --app-name <app-name> \
    --routes-file sample.json

  6. Ellenőrizze a létrehozott útvonalak válaszát. Az útvonalakat a portálon is megtekintheti.

Közzétett API-k megtekintése az API Portalon

Feljegyzés

A Tanzuhoz készült Spring Cloud Gateway és az API Portal közötti szinkronizálás néhány percet vesz igénybe.

Válassza ki az endpoint URL API Portalra való ugráshoz. A Tanzuhoz készült Spring Cloud Gatewayben konfigurált összes útvonal megjelenik.

Képernyőkép a konfigurált útvonalakat megjelenítő API-portálról.

API-k kipróbálás az API Portalon

Az API-k kipróbálásához kövesse az alábbi lépéseket:

  1. Válassza ki a kipróbálni kívánt API-t.

  2. Válassza az EXECUTE lehetőséget, és megjelenik a válasz.

    Képernyőkép az API-portálról, amelyen a Kiválasztott Végrehajtás lehetőség látható.

API-portál engedélyezése/letiltása a szolgáltatás létrehozása után

A szolgáltatás létrehozása után engedélyezheti és letilthatja az API Portalt az Azure Portal vagy az Azure CLI használatával. Az API Portal letiltása előtt le kell bontani annak végpontját.

Az ALÁBBI lépésekkel engedélyezheti vagy letilthatja az API Portalt az Azure Portal használatával:

  1. Keresse meg a szolgáltatáserőforrást, majd válassza az API Portalt.
  2. Válassza a Kezelés lehetőséget.
  3. Válassza az API-portál engedélyezése lehetőséget, vagy törölje a jelölését, majd válassza a Mentés lehetőséget.
  4. Most már megtekintheti az API Portal állapotát az API Portal oldalán.

Következő lépések