API Gateway에서 포털 제품 생성
다음 절차는 포털 제품을 생성하는 방법을 보여 줍니다. 포털은 포털 제품의 모음입니다. 포털 제품을 생성한 후 제품 REST 엔드포인트 및 제품 페이지를 생성합니다. 포털 제품에 대한 자세한 내용은 API Gateway의 포털 제품 섹션을 참조하세요.
고려 사항
다음 고려 사항은 포털 제품을 생성하는 방법에 영향을 미칠 수 있습니다.
-
포털 제품에는 프라이빗 및 퍼블릭 REST API가 모두 포함될 수 있습니다. 프라이빗 API는 사용해 보기 기능에 지원되지 않으므로 포털에서 시각적 차이가 있습니다. 포털 소유자는 이에 대해 설명하는 문서를 제공해야 할 수 있습니다.
-
AWS CLI 또는 AWS SDK를 사용하여 포털 제품을 생성하는 경우 포털에 제품 엔드포인트 또는 제품 페이지가 없습니다. AWS CLI 또는 콘솔을 사용하여 이러한 리소스를 추가해야 합니다. 제품 REST 엔드포인트를 생성하는 방법을 알아보려면 API Gateway에서 REST 엔드포인트 생성 섹션을 참조하세요. 제품 페이지를 생성하는 방법을 알아보려면 API Gateway에서 제품 페이지 생성 섹션을 참조하세요.
포털 제품 생성
다음 절차는 포털 제품을 생성하는 방법을 보여 줍니다.
포털 제품 생성
https://console.aws.amazon.com/apigateway
에서 API Gateway 콘솔에 로그인합니다. -
기본 탐색 창에서 포털 제품을 선택합니다.
-
제품 생성을 선택합니다.
-
제품 이름에 포털 제품의 이름을 입력합니다.
-
제품 설명에 설명을 입력합니다.
-
다음을 선택합니다.
-
제품 REST 엔드포인트를 선택하려면 API 엔드포인트에서 API를 선택한 다음 스테이지를 선택합니다.
-
제품 REST 엔드포인트에 엔드포인트를 추가하려면 API 엔드포인트를 선택한 다음 제품에 추가를 선택합니다.
참고
먼저 제품에 추가를 선택하지 않은 상태로 다음을 선택하지 마세요.
API 엔드포인트가 선택한 API 엔드포인트 목록에 나타납니다.
-
다음을 선택합니다.
-
선택한 내용을 검토하고 제품 생성을 선택합니다.
콘솔을 사용하여 포털 제품을 생성한 후에는 모든 제품 페이지와 제품 REST 엔드포인트 페이지가 초안이며 포털에 표시되지 않습니다. 제품 페이지와 제품 REST 엔드포인트 페이지를 소비자에게 표시하려면 섹션에 초안을 추가해야 합니다. AWS CLI 또는 AWS SDK를 사용하여 포털 제품을 생성하는 경우 AWS CLI 명령의 섹션에 초안을 추가합니다. 섹션에 초안을 추가하는 방법에 관계없이 포털 제품을 사용하는 포털을 게시하여 소비자에게 표시해야 합니다.
페이지 섹션에 초안 추가
-
초안은 설명서 탭에 나열됩니다. 제품 페이지에 대한 초안 설명서 페이지와 제품 REST 엔드포인트 페이지에 대한 초안 API 참조 페이지가 있습니다. 초안 API 참조 페이지를 선택합니다.
-
초안 API 참조 페이지를 선택합니다.
제품 REST 엔드포인트가 없는 경우 초안 API 참조 페이지가 없습니다. 제품 REST 엔드포인트를 생성하는 방법을 알아보려면 API Gateway에서 REST 엔드포인트 생성 섹션을 참조하세요.
-
페이지 편집을 선택합니다.
-
이 페이지에서 기존 API 설명서 부분을 덮어쓰거나 API Gateway 설명서를 사용할 수 있습니다. 제품 REST 엔드포인트 페이지의 내용을 소비자에게 표시하려면 섹션 이름에 이름을 입력합니다.
/pets-GET엔드포인트인 경우 페이지 이름은Pets일 수 있습니다. -
변경 사항 저장을 선택합니다.
-
생성한 새 페이지 이름이 API 참조 페이지 섹션 아래에 나타납니다.
새 페이지를 소비자에게 표시하려면 포털을 다시 게시해야 합니다. 자세한 내용은 API Gateway에 포털 게시 섹션을 참조하세요.
