API Gateway 포털 사용 - Amazon API Gateway

API Gateway 포털 사용

포털을 게시하면 웹에서 사용할 수 있습니다. 포털을 사용하려면 포털 기본 도메인 이름 또는 도메인 이름을 복사하여 브라우저에 입력합니다. 포털에서 도메인 이름을 사용하는 경우 기본 도메인 이름을 사용하여 포털에 액세스할 수 없습니다.

포털 사용

다음 절차에서는 포털에 액세스하여 제품 REST 엔드포인트에 대해 사용해 보기를 사용하는 방법을 보여 줍니다.

포털 사용
  1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

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

  3. 포털을 선택합니다.

  4. 포털 기본 도메인 이름 또는 도메인 이름을 복사하여 브라우저에 입력합니다.

  5. 포털 홈페이지에서 포털 제품을 검색하고 제품 페이지를 검색할 수 있습니다. 포털 상단의 검색을 사용하여 포털의 모든 콘텐츠를 검색합니다. 제품 아래의 검색 창을 사용하여 포털 제품을 검색합니다.

  6. 포털 제품을 선택합니다.

  7. 제품 REST 엔드포인트를 선택합니다.

  8. 사용해 보기 창에서 API 직접 호출을 시도하는 파라미터를 입력합니다.

  9. 사용해 보기를 선택합니다. API Gateway가 API를 간접적으로 호출하고 창에 결과를 표시합니다.

포털 문제 해결

다음은 포털을 사용할 때 발생할 수 있는 오류와 문제에 대한 문제 해결 조언을 제공합니다.

포털 웹 페이지 사이트에 연결할 수 없음

포털 웹 페이지 사이트에 연결할 수 없다는 오류 메시지가 표시되면 포털을 게시했는지 확인합니다. 도메인 이름을 사용한 경우 API Gateway가 트래픽을 사용자 지정 도메인의 CloudFront 배포로 전달하기 위해 제공한 별칭 레코드를 추가했는지 확인합니다.

사용해 보기 실패

제품 REST 엔드포인트에 대해 사용해 보기를 사용할 수 없는 경우 해당 사용해 보기 상태가 ACTIVE인지 확인합니다. 또한 API를 간접적으로 호출할 올바른 파라미터를 입력했는지 확인합니다.

포털에 페이지가 표시되지 않음

제품 REST 엔드포인트 페이지 또는 제품 페이지를 생성했는데 포털에 표시되지 않는 경우 페이지가 초안이 아닌지 확인합니다. 이를 확인하기 위해 다음을 수행합니다.

페이지가 초안이 아닌지 확인
  1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

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

  3. 포털 제품을 선택합니다.

  4. 설명서 탭에서 페이지가 초안 설명서 페이지 또는 초안 API 참조 페이지 섹션이 아니라 사용자 지정 설명서 페이지 또는 API 참조 페이지에 있는지 확인합니다.