다음을 통해 공유

Amazon API Gateway에서 Azure API Center로 API 동기화(미리 보기)

  • 아티클

이 문서에서는 게이트웨이의 API가 API 센터 인벤토리에서 지속적으로 최신 상태로 유지되도록 Amazon API 게이트웨이를 통합하는 방법을 보여 줍니다.

Amazon API 게이트웨이 통합 정보

Amazon API Gateway를 API 센터의 API 원본으로 통합하면 API 인벤토리가 최신 상태로 유지되도록 지속적인 동기화가 가능합니다. Azure API Center는 Azure API Management를 비롯한 원본의 API를 동기화할 수도 있습니다.

Amazon API 게이트웨이를 API 원본으로 통합하면 다음이 발생합니다.

  1. API 게이트웨이의 API 및 선택적으로 API 정의(사양)가 API 센터 인벤토리에 추가됩니다.
  2. API 센터에서 Amazon API Gateway 유형의 환경을 구성합니다.
  3. 동기화된 각 API 정의에 대해 연결된 배포 가 만들어집니다.

동기화는 Amazon API 게이트웨이에서 Azure API 센터로의 단방향입니다. 즉, API 센터의 API 업데이트가 Amazon API 게이트웨이로 다시 동기화되지 않습니다.

참고 항목

  • Amazon API 게이트웨이의 통합은 현재 미리 보기로 제공됩니다.
  • 통합 API 원본 수에는 제한이 있습니다.
  • Amazon API Gateway의 API는 시간당 한 번씩 API 센터에 동기화됩니다. REST API만 동기화됩니다.
  • 통합하는 동안 API 정의를 포함하는 옵션을 선택하면 API 정의도 API 센터에 동기화됩니다. 배포된 API의 정의만 동기화됩니다.

Amazon API 게이트웨이에서 동기화된 엔터티

API를 검색, 이해 및 사용할 수 있도록 API 센터의 동기화된 API에 메타데이터 속성 및 설명서를 추가하거나 업데이트할 수 있습니다. Azure API Center의 기본 제공 및 사용자 지정 메타데이터 속성에 대해 자세히 알아봅니다.

다음 표에서는 Azure API 센터에서 수정할 수 있는 엔터티 속성과 API 원본의 값을 기반으로 설정된 속성을 보여 있습니다.

Entity API 센터에서 구성할 수 있는 속성 통합 API 원본에서 결정되는 속성
API 요약
lifecycleStage
termsOfService
license
externalDocumentation
customProperties		 title
description
kind
API 버전 lifecycleStage title
정의(동기화된 경우)
Environment title
description
kind
server.managementPortalUri
온보딩
customProperties		 server.type
배포 title
description
server
state
customProperties		 server.runtimeUri

참고 항목

Azure API Center에 동기화된 엔터티에 대한 리소스 및 시스템 ID는 자동으로 생성되며 변경할 수 없습니다.

필수 조건

  • Azure 구독의 API 센터입니다. 아직 API 센터를 만들지 않았다면 빠른 시작: API 센터 만들기를 참조하세요.

  • Azure 키 자격 증명 모음. 만들어야 하는 경우 빠른 시작: Azure Portal을 사용하여 키 자격 증명 모음 만들기를 참조하세요. 키 자격 증명 모음에서 비밀을 추가하거나 관리하려면 적어도 Key Vault 비밀 책임자 역할 또는 동등한 권한이 필요합니다.

  • Amazon API 게이트웨이.

  • 정책이 연결된 AWS IAM 사용자 ID AmazonAPIGatewayAdministrator 입니다.

  • Azure CLI의 경우:

    참고 항목

    az apic 명령에는 apic-extension Azure CLI 확장이 필요합니다. az apic 명령을 사용하지 않은 경우 첫 번째 az apic 명령을 실행할 때 확장을 동적으로 설치하거나 확장을 수동으로 설치할 수 있습니다. Azure CLI 확장에 대해 자세히 알아보세요.

    apic-extension의 최신 변경 내용 및 업데이트는 릴리스 정보를 참조하세요. 특정 기능에는 미리 보기 또는 특정 버전의 확장이 필요할 수 있습니다.

    참고 항목

    이 문서의 Azure CLI 명령 예제는 PowerShell 또는 bash 셸에서 실행할 수 있습니다. 변수 구문이 다르기 때문에 필요한 경우 두 셸에 대해 별도의 명령 예가 제공됩니다.

IAM 사용자 액세스 키 만들기

Amazon API Gateway에 대한 API 센터를 인증하려면 AWS IAM 사용자에 대한 액세스 키가 필요합니다.

AWS 관리 콘솔을 사용하여 필요한 액세스 키 ID 및 비밀 키를 생성하려면 AWS 설명서에서 직접 액세스 키 만들기를 참조하세요.

안전한 위치에 선택키를 저장합니다. 다음 단계에서 Azure Key Vault에 저장합니다.

주의

액세스 키는 장기 자격 증명이며 암호처럼 안전하게 관리해야 합니다. 액세스 키 보안에 대해 자세히 알아보기

Azure Key Vault에 IAM 사용자 액세스 키 저장

다음 표에 권장되는 구성을 사용하여 Azure Key Vault에 두 개의 IAM 사용자 액세스 키를 수동으로 업로드하고 안전하게 저장합니다. 자세한 내용은 빠른 시작: Azure Portal을 사용하여 Azure Key Vault에서 비밀 설정 및 검색을 참조하세요.

AWS 비밀 업로드 옵션 속성 비밀 값
액세스 키 설명서 aws-access-key AWS에서 검색된 액세스 키 ID
비밀 액세스 키 설명서 aws-secret-access-key AWS에서 검색된 비밀 액세스 키

포털의 Azure Key Vault에 있는 비밀 목록 스크린샷

각 비밀의 비밀 식별자 (URI는 다음과 유사)를 기록해 https://<key-vault-name>.vault.azure.net/secrets/<secret-name>둡니다. 다음 단계에서 이러한 식별자를 사용합니다.

API 센터에서 관리 ID 사용

이 시나리오의 경우 API 센터는 관리 ID를 사용하여 Azure 리소스에 액세스합니다. 필요에 따라 시스템 할당 또는 하나 이상의 사용자 할당 관리 ID를 사용하도록 설정합니다.

다음 예제에서는 Azure Portal 또는 Azure CLI를 사용하여 시스템 할당 관리 ID를 사용하도록 설정하는 방법을 보여 줍니다. 높은 수준에서 구성 단계는 사용자 할당 관리 ID와 유사합니다.

  1. 포털에서 API 센터로 이동합니다.
  2. 왼쪽 메뉴의 보안 아래에서 관리 ID를 선택합니다.
  3. 시스템 할당을 선택하고 상태를 켬으로 설정합니다.
  4. 저장을 선택합니다.

관리 ID에 Key Vault 비밀 사용자 역할 할당

API 가져오기를 허용하려면 API 센터의 관리 ID를 Azure Key Vault의 Key Vault 비밀 사용자 역할을 할당합니다. 포털 또는 Azure CLI를 사용할 수 있습니다.

  1. 포털에서 키 자격 증명 모음으로 이동합니다.
  2. 왼쪽 메뉴에서 액세스 제어(IAM)를 선택합니다.
  3. + 역할 할당 추가를 선택합니다.
  4. 역할 할당 추가 페이지에서 다음과 같이 값을 설정합니다.
    1. 역할 탭에서 Key Vault 비밀 사용자를 선택합니다.
    2. 구성원 탭의 액세스 할당에서 관리 ID>+ 구성원 선택을 선택합니다.
    3. 관리 ID 선택 페이지에서 이전 섹션에서 추가한 API 센터의 시스템 할당 관리 ID를 선택합니다. 선택을 클릭합니다.
    4. 검토 + 할당을 선택합니다.

Amazon API 게이트웨이 통합

az apic integration create aws(미리 보기) 명령을 실행하여 Amazon API Gateway를 API 센터에 통합합니다.

  • 리소스 그룹, API 센터 및 통합의 이름을 제공합니다.

  • AWS 액세스 키 및 비밀 액세스 키에 대한 Key Vault 비밀 식별자와 Amazon API 게이트웨이가 배포된 AWS 지역을 제공합니다.

az apic integration create aws \
    --resource-group <resource-group-name> \
    --service-name-name <api-center-name> \
    --integration-name <aws-integration-name> \
    --aws-access-key-reference <access-key-uri> \
    --aws-secret-access-key-reference <secret-access-key-uri> 
    --aws-region-name <aws-region>

환경이 API 센터에 추가됩니다. Amazon API 게이트웨이 API는 API 센터 인벤토리로 가져옵니다.

통합 삭제

API 원본이 통합되어 있는 동안에는 API 센터에서 동기화된 API를 삭제할 수 없습니다. 필요한 경우 통합을 삭제할 수 있습니다. 통합을 삭제하는 경우:

  • API 센터 인벤토리의 동기화된 API가 삭제됩니다.
  • API 원본과 연결된 환경 및 배포가 삭제됩니다.

Azure CLI를 사용하여 통합을 삭제하려면 az apic integration delete(미리 보기) 명령을 실행합니다. 리소스 그룹, API 센터 및 통합의 이름을 제공합니다.

az apic integration delete \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <integration-name>

관련 콘텐츠