포털에서 API Gateway 제품 REST 엔드포인트에 대해 사용해 보기 활성화 - Amazon API Gateway
고려 사항제품 REST 엔드포인트에 대해 사용해 보기 활성화

포털에서 API Gateway 제품 REST 엔드포인트에 대해 사용해 보기 활성화

API 소비자가 포털에서 제품 엔드포인트를 간접적으로 호출하도록 하려면 사용해 보기를 사용합니다. API 소비자가 사용해 보기를 사용할 때 메서드 요청 파라미터를 입력하고 제품 엔드포인트를 간접적으로 호출합니다. 그런 다음 API Gateway는 퍼블릭 인터넷을 통해 API를 간접적으로 호출하고 사용해 보기 창에 응답을 반환합니다. 사용자 지정 제품 페이지를 사용하여 API에 액세스하는 데 필요한 파라미터에 대한 추가 정보를 제공할 수 있습니다.

API Gateway는 다음 제한을 사용하여 API를 보호합니다.

  • API Gateway는 API에 대해 초당 3개의 요청만 허용합니다.

  • API Gateway는 기본 제공 제한 시간인 29,000ms를 사용합니다. 실제 API의 제한 시간이 더 길 수 있지만, 고객이 사용해 보기를 사용할 때는 API Gateway가 이 제한 시간을 적용하지 않습니다.

  • API Gateway는 응답 페이로드를 6MB로 제한합니다.

고려 사항

다음 고려 사항은 사용해 보기 사용 방법에 영향을 미칠 수 있습니다.

  • 포털을 미리 볼 때는 사용해 보기가 지원되지 않습니다.

  • 다음 기능이 있는 REST API에는 사용해 보기가 지원되지 않습니다.

    • 프라이빗 API

    • 상호 TLS를 사용하는 API

    • 프라이빗 또는 자체 서명된 SSL 인증서를 사용하는 API

    포털 소유자는 지원되지 않는 REST API에 사용해 보기 버튼이 없는 이유에 대해 API 소비자에게 알릴 책임이 있습니다. API Gateway는 이를 설명하지 않습니다.

제품 REST 엔드포인트에 대해 사용해 보기 활성화

다음 절차에서는 제품 엔드포인트에 대해 사용해 보기를 활성화하는 방법을 보여 줍니다.

포털에서 사용해 보기를 사용하는 방법을 알아보려면 API Gateway 포털 사용 섹션을 참조하세요.

제품 REST 엔드포인트에 대해 사용해 보기 활성화

  1. 기본 탐색 창에서 포털 제품을 선택합니다.

  2. 제품을 선택합니다.

  3. 설명서 탭의 API 참조 페이지에서 /dogs - GET과 같은 제품 REST 엔드포인트의 이름을 선택합니다.

  4. 페이지 편집을 선택합니다.

  5. 고객이 포털에서 API를 간접적으로 호출하도록 하려면 사용해 보기 기능을 선택합니다.

  6. 변경 사항 저장을 선택합니다.

  7. 변경 사항을 적용하려면 이 포털 제품을 사용하는 포털을 다시 게시해야 합니다.