Использование портала API для VMware Tanzu

Эта статья относится к: ❎ Basic/Standard ✅ Enterprise

В этой статье показано, как использовать портал API для VMware Tanzu с планом Azure Spring Apps Enterprise.

Портал API является одним из коммерческих компонентов VMware Tanzu. Портал API поддерживает просмотр определений API из Шлюза Spring Cloud для VMware Tanzu и тестирования определенных маршрутов API из браузера. Она также поддерживает настройку аутентификации единого входа (SSO) с помощью конфигурации.

Предварительные условия

• Уже развернутый экземпляр плана Azure Spring Apps Enterprise с включенным API-порталом. Для получения дополнительной информации см. краткое руководство: создание и развертывание приложений в Azure Spring Apps, используя план Enterprise.
• Шлюз Spring Cloud для Tanzu включается во время подготовки и для него настраиваются соответствующие метаданные API.

Настройка единого входа (SSO)

Портал API поддерживает проверку подлинности и авторизацию через единый вход (SSO) при использовании поставщика удостоверений OpenID, который поддерживает протокол OpenID Connect Discovery.

Чтобы настроить единый вход с идентификатором Microsoft Entra, см. инструкции по настройке единого входа с помощью Идентификатора Microsoft Entra для Spring Cloud Gateway и портала API для Tanzu.

Настройка счетчика экземпляров

az spring api-portal update --instance-count <number>

Назначение общедоступной конечной точки для портала API

az spring api-portal update --assign-endpoint

Настройка функции пробного интерфейса API

Портал API позволяет централизованно просматривать API и пробовать их с помощью функции пробной версии API. Пробная попытка API включена по умолчанию, и эта конфигурация помогает отключить ее во всем экземпляре портала API. Дополнительные сведения см. в разделе "Пробные API" в разделе портала API.

az spring api-portal update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name> \
    --enable-api-try-out

az spring api-portal update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name> \
    --enable-api-try-out false

Настройка маршрутизации API с помощью спецификации OpenAPI в Spring Cloud Gateway для Tanzu

В этом разделе описывается, как просматривать и пробовать API с определениями схем на портале API. Выполните следующие действия, чтобы настроить маршрутизацию API с URL-адресом спецификации OpenAPI в Spring Cloud Gateway для Tanzu.

1. Создайте приложение в Azure Spring Apps, в которое шлюз направляет трафик.

2. Создайте определение OpenAPI и получите URI для доступа к нему. Принимаются следующие два варианта URI:

   • Первый вариант — использовать общедоступную конечную точку, например URI https://petstore3.swagger.io/api/v3/openapi.json, которая включает спецификацию OpenAPI.
   • Второй вариант — поместить определение OpenAPI в относительный путь приложения в Azure Spring Apps и создать URI в формате http://<app-name>/<relative-path-to-OpenAPI-spec>. Вы можете выбрать средства SpringDocs для автоматического создания спецификации OpenAPI, поэтому URI может быть таким же http://<app-name>/v3/api-docs.

3. Используйте следующую команду, чтобы назначить общедоступную конечную точку шлюзу для доступа к нему.

   az spring gateway update --assign-endpoint
   

4. Настройте свойства Шлюза Spring Cloud для Tanzu, используя следующую команду:

   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. Настройте правила маршрутизации для приложений.

   Чтобы создать правила для доступа к приложению в Spring Cloud Gateway для конфигурации маршрута Tanzu, сохраните следующее содержимое в файле sample.json .

   {
      "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 является общедоступная конечная точка или универсальный код ресурса (URI), созданный на втором шаге выше. Вы можете добавлять предикаты и фильтры для путей, определенных в спецификации OpenAPI.

   Используйте следующую команду, чтобы применить правило к приложению, созданному на первом шаге:

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

6. Проверьте ответ созданных маршрутов. Вы также можете просмотреть маршруты на портале.

Просмотр предоставляемых API на портале API

Щелкните endpoint URL, чтобы перейти к порталу API. Вы увидите все маршруты, настроенные в Spring Cloud Gateway для Tanzu.

Пробное использование API на портале API

Используйте следующие шаги, чтобы попробовать API:

1. Выберите приложение API, которое вы решили применить.

2. Выберите EXECUTE и появится ответ.

   

Включение и отключение портала API после создания службы

Вы можете включить и отключить портал API после создания службы с помощью портал Azure или Azure CLI. Перед отключением портала API необходимо отменить назначение конечной точки.

az spring api-portal create \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

az spring api-portal delete \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

Следующие шаги

• Azure Spring Apps