VMware Tanzu용 API 포털 사용

아티클
10/01/2024

참고 항목

기본, 표준 및 엔터프라이즈 계획은 2025년 3월 중순부터 사용되지 않으며 3년의 은퇴 기간이 있습니다. Azure Container Apps로 전환하는 것이 좋습니다. 자세한 내용은 Azure Spring Apps 사용 중지 공지 사항을 참조하세요.

표준 소비 및 전용 계획은 2024년 9월 30일부터 사용되지 않으며 6개월 후에 완전히 종료됩니다. Azure Container Apps로 전환하는 것이 좋습니다. 자세한 내용은 Azure Spring Apps 표준 사용량 및 전용 계획을 Azure Container Apps로 마이그레이션을 참조 하세요.

이 문서는 기본/표준 ✅ 엔터프라이즈에 ❎ 적용됩니다.

이 문서에서는 Azure Spring Apps 엔터프라이즈 플랜에서 VMware Tanzu용 API 포털을 사용하는 방법을 보여 줍니다.

API 포털은 상용 VMware Tanzu 구성 요소 중 하나입니다. API 포털은 VMware Tanzu용 Spring Cloud Gateway에서 API 정의를 보고 브라우저에서 특정 API 경로를 테스트할 수 있도록 지원합니다. 또한 구성을 통해 SSO(Single Sign-On) 인증 사용 설정을 지원합니다.

필수 조건

API 포털을 사용하도록 설정된 이미 프로비전된 Azure Spring Apps 엔터프라이즈 플랜 인스턴스입니다. 자세한 내용은 빠른 시작: 엔터프라이즈 플랜을 사용하여 Azure Spring Apps에 앱 빌드 및 배포를 참조하세요.
Spring Cloud Gateway for Tanzu는 프로비저닝 중에 사용하도록 설정되고 해당 API 메타데이터가 구성됩니다.

SSO(Single Sign-On) 구성

API 포털은 OpenID Connect Discovery 프로토콜을 지원하는 IdP(OpenID ID 공급자)와 함께 SSO(Single Sign-On)를 사용하여 인증 및 권한 부여를 지원합니다.

참고 항목

OpenID Connect Discovery 프로토콜을 지원하는 권한 부여 서버만 지원됩니다. API 포털로 다시 리디렉션할 수 있도록 외부 권한 부여 서버를 구성해야 합니다. 권한 부여 서버의 설명서를 참조하고 허용되는 리디렉션 URI 목록에 https://<api-portal-external-url>/login/oauth2/code/sso를 추가합니다.

속성	필수 여부	설명
issuerUri	예	앱에서 발급자 식별자로 어설션하는 URI입니다. 예를 들어 제공된 issuer-uri가 "https://example.com"이면 OpenID 공급자 구성 요청이 "https://example.com/.well-known/openid-configuration"으로 만들어집니다. 결과는 OpenID 공급자 구성 응답이 될 것으로 예상됩니다.
clientId	예	IdP에서 제공하는 OpenID Connect 클라이언트 ID
clientSecret	예	IdP에서 제공하는 OpenID Connect 클라이언트 암호
scope	예	JWT ID 토큰에 포함할 범위 목록입니다. 이 목록은 ID 공급자가 허용하는 범위를 기반으로 해야 합니다.

Microsoft Entra ID를 사용하여 SSO를 설정하려면 Spring Cloud Gateway 및 Tanzu용 API 포털에 대해 Microsoft Entra ID로 Single Sign-On을 설정하는 방법을 참조하세요.

참고 항목

잘못된 암호와 같은 잘못된 SSO 속성을 구성하는 경우 전체 SSO 속성을 제거하고 올바른 구성을 다시 추가해야 합니다.

API 포털을 사용하여 인스턴스 수를 구성하려면 다음 단계를 사용합니다.

서비스 인스턴스로 이동하고 API 포털을 선택합니다.
스케일 아웃을 선택합니다.
인스턴스 수를 구성한 다음 저장을 선택합니다.

API 포털을 사용하여 인스턴스 수를 구성하려면 다음 명령을 사용합니다. 자리 표시자를 실제 값으로 바꿔야 합니다.

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

API 포털에 대한 퍼블릭 엔드포인트 할당

Azure Portal
Azure CLI

API 포털에 퍼블릭 엔드포인트를 할당하려면 다음 단계를 따릅니다.

API 포털을 선택합니다.
개요를 선택하여 API 포털에 할당된 실행 상태 및 리소스를 확인합니다.
엔드포인트 할당 옆에 있는 예를 선택하여 퍼블릭 엔드포인트를 할당합니다. URL이 몇 분 내에 생성됩니다.
나중에 사용할 수 있도록 URL을 저장합니다.

다음 명령을 사용하여 API 포털에 퍼블릭 엔드포인트를 할당합니다.

az spring api-portal update --assign-endpoint

API 체험 기능 구성

API 포털을 사용하면 API를 중앙에서 확인하고 API 체험 기능을 사용하여 사용해 볼 수 있습니다. API 체험 기능은 기본적으로 사용하도록 설정되며 이 구성을 사용하면 전체 API 포털 인스턴스에서 이 기능을 끌 수 있습니다. 자세한 내용은 API 포털에서 API 사용해 보기 섹션을 참조하세요.

Azure Portal
Azure CLI

다음 단계에 따라 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

다음 명령을 사용하여 API 체험을 사용하지 않도록 설정합니다.

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

Tanzu용 Spring Cloud Gateway에서 OpenAPI 사양으로 API 라우팅 구성

이 섹션에서는 API 포털에서 스키마 정의를 사용하여 API를 보고 시도하는 방법을 설명합니다. Tanzu용 Spring Cloud Gateway에서 OpenAPI 사양 URL로 API 라우팅을 구성하려면 다음 단계를 사용합니다.

게이트웨이가 트래픽을 라우팅하는 Azure Spring Apps에서 앱을 만듭니다.
OpenAPI 정의를 생성하고 이에 액세스하기 위한 URI를 가져옵니다. 다음 두 가지 URI 옵션이 허용됩니다.
- 첫 번째 옵션은 OpenAPI 사양을 포함하는 URI https://petstore3.swagger.io/api/v3/openapi.json과 같이 공개적으로 액세스 가능한 엔드포인트를 사용하는 것입니다.
- 두 번째 옵션은 Azure Spring Apps에서 앱의 상대 경로에 OpenAPI 정의를 넣고 http://<app-name>/<relative-path-to-OpenAPI-spec> 형식으로 URI를 구성하는 것입니다. SpringDocs와 같은 도구를 선택하여 OpenAPI 사양을 자동으로 생성할 수 있으므로 URI는 http://<app-name>/v3/api-docs와 같을 수 있습니다.
다음 명령을 사용하여 액세스할 게이트웨이에 공용 엔드포인트를 할당합니다.
```
az spring gateway update --assign-endpoint
```

다음 명령을 사용하여 Spring Cloud Gateway for 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 "*"

앱에 대한 회람 규칙을 구성합니다.

Tanzu 경로 구성을 위한 Spring Cloud Gateway에서 앱에 액세스하는 규칙을 만들려면 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
```
만들어진 경로의 응답을 확인합니다. 포털에서 경로를 볼 수도 있습니다.

API 포털에서 노출된 API 보기

참고 항목

Spring Cloud Gateway for Tanzu와 API 포털 간에 동기화하는 데 몇 분 정도 걸립니다.

endpoint URL을 선택하여 API 포털로 이동합니다. Spring Cloud Gateway for Tanzu에 구성된 모든 경로가 표시됩니다.

구성된 경로를 보여 주는 API 포털의 스크린샷

API 포털에서 API 사용해 보기

API를 사용해 보려면 다음 단계를 따릅니다.

사용해 보려는 API를 선택합니다.
EXECUTE를 선택하면 응답이 표시됩니다.

서비스를 만든 후 API 포털 사용/사용 안 함

Azure Portal 또는 Azure CLI를 사용하여 서비스를 만든 후 API 포털을 사용하거나 사용하지 않도록 설정할 수 있습니다. API 포털을 사용하지 않도록 설정하기 전에 엔드포인트를 할당 취소해야 합니다.

Azure Portal
Azure CLI

다음 단계를 사용하여 Azure Portal을 사용하여 API 포털을 사용하거나 사용하지 않도록 설정합니다.

서비스 리소스로 이동한 다음, API 포털을 선택합니다.
관리를 선택합니다.
API 포털 사용을 선택하거나 선택 취소한 다음, 저장을 선택합니다.
이제 API 포털 페이지에서 API 포털의 상태를 볼 수 있습니다.

다음 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

다음을 통해 공유

VMware Tanzu용 API 포털 사용

필수 조건

SSO(Single Sign-On) 구성

인스턴스 수 구성

API 포털에 대한 퍼블릭 엔드포인트 할당

API 체험 기능 구성

Tanzu용 Spring Cloud Gateway에서 OpenAPI 사양으로 API 라우팅 구성

API 포털에서 노출된 API 보기

API 포털에서 API 사용해 보기

서비스를 만든 후 API 포털 사용/사용 안 함

다음 단계

피드백

추가 리소스