Share via

VMware Tanzu için API portalını kullanma

  • Makale

Not

Azure Spring Apps, Azure Spring Cloud hizmetinin yeni adıdır. Hizmetin yeni bir adı olsa da, ekran görüntüleri, videolar ve diyagramlar gibi varlıkları güncelleştirmek için çalışırken bazı yerlerde eski adı bir süre görürsünüz.

Bu makale şunlar için geçerlidir:❌ Temel/Standart ✔️ Kurumsal

Bu makalede, Azure Spring Apps Kurumsal planıyla VMware Tanzu için API portalını nasıl kullanacağınız gösterilmektedir.

API portalı , ticari VMware Tanzu bileşenlerinden biridir. API portalı, VMware Tanzu için Spring Cloud Gateway'den API tanımlarının görüntülenmesini ve tarayıcıdan belirli API yollarının testini destekler. Ayrıca yapılandırma aracılığıyla çoklu oturum açma (SSO) kimlik doğrulamasını etkinleştirmeyi de destekler.

Önkoşullar

  • API portalının etkinleştirildiği, önceden sağlanmış bir Azure Spring Apps Kurumsal plan örneği. Daha fazla bilgi için bkz . Hızlı Başlangıç: Kurumsal planı kullanarak uygulamaları derleme ve Azure Spring Apps'e dağıtma.
  • Tanzu için Spring Cloud Gateway sağlama sırasında etkinleştirilir ve buna karşılık gelen API meta verileri yapılandırılır.

Çoklu oturum açmayı (SSO) yapılandırma

API portalı, OpenID Bağlan Bulma protokollerini destekleyen bir OpenID kimlik sağlayıcısı (IdP) ile çoklu oturum açma (SSO) kullanarak kimlik doğrulamasını ve yetkilendirmeyi destekler.

Not

Yalnızca OpenID Bağlan Bulma protokollerini destekleyen yetkilendirme sunucuları desteklenir. Api portalına yeniden yönlendirmelere izin vermek için dış yetkilendirme sunucusunu yapılandırdığından emin olun. Yetkilendirme sunucunuzun belgelerine bakın ve izin verilen yeniden yönlendirme URI'leri listesine ekleyin https://<api-portal-external-url>/login/oauth2/code/sso .

Özellik Gerekli mi? Açıklama
issuerUri Yes Uygulamanın Veren Tanımlayıcısı olarak onay verdiği URI. Örneğin, verilen veren-uri ";ise, "https://example.com"https://example.com/.well-known/openid-configuration" için bir OpenID Sağlayıcısı Yapılandırma İsteği yapılır. Sonucun bir OpenID Sağlayıcısı Yapılandırma Yanıtı olması beklenir.
clientId Yes IdP'niz tarafından sağlanan OpenID Bağlan istemci kimliği
clientSecret Yes IdP'niz tarafından sağlanan OpenID Bağlan istemci gizli dizisi
kapsam Yes JWT kimlik belirteçlerine eklenecek kapsamların listesi. Bu liste, kimlik sağlayıcınız tarafından izin verilen kapsamları temel almalıdır

Microsoft Entra Id ile SSO ayarlamak için bkz . Spring Cloud Gateway için Microsoft Entra Id ve Tanzu için API Portalı ile çoklu oturum açma ayarlama.

Not

Yanlış parola gibi yanlış SSO özelliğini yapılandırdığınızda, SSO özelliğinin tamamını kaldırmanız ve doğru yapılandırmayı yeniden eklemeniz gerekir.

Örnek sayısını yapılandırma

API portalını kullanarak örnek sayısını yapılandırmak için aşağıdaki adımları kullanın:

  1. Hizmet örneğinize gidin ve API portalını seçin.
  2. Ölçeği genişlet'i seçin.
  3. Örnek sayısını yapılandırın ve kaydet'i seçin.

API portalı için genel uç nokta atama

API portalına genel uç nokta atamak için aşağıdaki adımları kullanın:

  1. API portalı'nın seçin.
  2. API portalına ayrılan çalışma durumunu ve kaynakları görüntülemek için Genel Bakış'ı seçin.
  3. Genel uç nokta atamak için Uç nokta ata'nın yanındaki Evet'i seçin. Birkaç dakika içinde bir URL oluşturulur.
  4. URL'yi daha sonra kullanmak üzere kaydedin.

API deneme özelliğini yapılandırma

API portalı API'leri merkezi olarak görüntülemenizi ve API deneme özelliğini kullanarak denemenizi sağlar. API denemesi varsayılan olarak etkindir ve bu yapılandırma tüm API portalı örneğinde kapatmanıza yardımcı olur. Daha fazla bilgi için API portalında API'leri deneme bölümüne bakın.

API denemesini etkinleştirmek veya devre dışı bırakmak için aşağıdaki adımları kullanın:

  1. Hizmet örneğinize gidin ve API portalını seçin.
  2. Yapılandırma'yı seçin.
  3. API denemesini etkinleştir'i seçin veya temizleyin ve ardından Kaydet'i seçin.

Tanzu için Spring Cloud Gateway'de OpenAPI Belirtimi ile API yönlendirmeyi yapılandırma

Bu bölümde API portalda şema tanımlarıyla API'lerin nasıl görüntülenip denendiği açıklanmaktadır. Tanzu için Spring Cloud Gateway'de OpenAPI belirtim URL'si ile API yönlendirmeyi yapılandırmak için aşağıdaki adımları kullanın.

  1. Azure Spring Apps'te ağ geçidinin trafiği yönlendiren bir uygulama oluşturun.

  2. OpenAPI tanımını oluşturun ve buna erişmek için URI'yi alın. Aşağıdaki iki URI seçeneği kabul edilir:

    • İlk seçenek, OpenAPI belirtimini içeren URI https://petstore3.swagger.io/api/v3/openapi.jsongibi genel olarak erişilebilir bir uç nokta kullanmaktır.
    • İkinci seçenek, OpenAPI tanımını Azure Spring Apps'te uygulamanın göreli yoluna yerleştirmek ve URI'yi biçiminde http://<app-name>/<relative-path-to-OpenAPI-spec>oluşturmaktır. URI'nin gibi http://<app-name>/v3/api-docsolabilmesi için OpenAPI belirtimini otomatik olarak oluşturmak için gibi SpringDocs araçlar seçebilirsiniz.

  3. Ağ geçidine erişmek üzere genel uç nokta atamak için aşağıdaki komutu kullanın.

    az spring gateway update --assign-endpoint

  4. Tanzu özellikleri için Spring Cloud Gateway'i yapılandırmak için aşağıdaki komutu kullanın:

    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. Uygulamalara yönlendirme kurallarını yapılandırın.

    Tanzu için Spring Cloud Gateway yol yapılandırmasında uygulamaya erişmek üzere kurallar oluşturmak için aşağıdaki içeriği sample.json dosyasına kaydedin.

    {
   "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"
         ]
      }
   ]
}

    open_api.uri Değer, yukarıdaki ikinci adımda yapılandırılan genel uç nokta veya URI'dir. OpenAPI belirtiminizde tanımlanan yollar için koşul ve filtreler ekleyebilirsiniz.

    Kuralı ilk adımda oluşturulan uygulamaya uygulamak için aşağıdaki komutu kullanın:

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

  6. Oluşturulan yolların yanıtını denetleyin. Yolları portalda da görüntüleyebilirsiniz.

Kullanıma sunulan API'leri API portalında görüntüleme

Not

Tanzu için Spring Cloud Gateway ile API portalı arasında eşitleme birkaç dakika sürer.

API portalına endpoint URL gitmek için öğesini seçin. Tanzu için Spring Cloud Gateway'de yapılandırılan tüm yolları görürsünüz.

Yapılandırılan yolları gösteren API portalının ekran görüntüsü.

API portalda API'leri deneyin

API'leri denemek için aşağıdaki adımları kullanın:

  1. Denemek istediğiniz API'yi seçin.

  2. YÜRÜT'e tıklayın ve yanıt görüntülenir.

    Yürüt seçeneğinin seçili olduğunu gösteren API portalının ekran görüntüsü.

Hizmet oluşturulduktan sonra API portalını etkinleştirme/devre dışı bırakma

Hizmet oluşturulduktan sonra Azure portalını veya Azure CLI'yı kullanarak API portalını etkinleştirebilir ve devre dışı bırakabilirsiniz. API portalını devre dışı bırakmadan önce uç noktasının atamasını kaldırmanız gerekir.

Azure portalını kullanarak API portalını etkinleştirmek veya devre dışı bırakmak için aşağıdaki adımları kullanın:

  1. Hizmet kaynağınıza gidin ve ARDıNDAN API portalı'na tıklayın.
  2. Yönet'i seçin.
  3. API portalını etkinleştir'i seçin veya seçimini kaldırın ve ardından Kaydet'i seçin.
  4. Artık API portalının durumunu API portalı sayfasında görüntüleyebilirsiniz.

Sonraki adımlar