API Gateway 포털 - Amazon API Gateway
고려 사항

API Gateway 포털

API Gateway 포털을 사용하여 웹 페이지의 API 소비자와 API 및 API 설명서를 공유할 수 있습니다. 포털에는 포털 제품 세트가 포함되어 있습니다. 각 포털 제품은 REST API의 논리적 그룹이며 API 소비자를 위해 생성하고 게시하는 설명서를 포함합니다. 포털 내의 제품 페이지에는 포털 제품 수준의 사용자 지정 설명서가 포함되어 있습니다. 제품 REST 엔드포인트 페이지에는 각 REST API 및 스테이지가 포함되어 있습니다. 제품 페이지와 제품 REST 엔드포인트 페이지의 조합은 API 소비자가 REST API 사용을 시작하는 방법을 배울 수 있도록 전체 설명서를 제공합니다.

포털을 사용하여 다음을 수행합니다.

  • API 생성부터 문서화 및 배포에 이르기까지 전체 API 수명 주기에 API Gateway를 사용합니다.

  • AWS 계정 간에 포털 제품을 공유합니다.

  • 포털 제품의 중앙 위치를 사용자 지정 및 공유하고 제품 페이지를 제공합니다.

고려 사항

다음 고려 사항은 API Gateway 포털 사용에 영향을 미칠 수 있습니다.

  • REST API를 공유하기 위해서만 포털을 생성할 수 있습니다.

  • 포털은 AWS 리전 수준에서 생성됩니다. 포털에는 포털을 생성하는 리전과 동일한 리전에 있는 REST API만 포함될 수 있습니다.

  • AWS Management 콘솔, AWS CLI 또는 AWS SDK만 사용하여 포털을 생성하고 공유할 수 있습니다.

  • Amazon Cognito 사용자 풀을 사용해야만 포털에 대한 액세스를 제어할 수 있습니다. 포털 소비자는 사용자 풀을 통해 직접 로그인하거나 타사 ID 제공업체(idP)를 통해 연동할 수 있습니다. Amazon Cognito 사용자 풀을 사용하는 경우 사용자 풀에 대한 클라이언트 보안 암호를 설정할 수 없습니다. 자세한 내용은 Amazon Cognito 사용자 풀을 참조하세요.