API Gateway에서 REST 엔드포인트 생성
제품 REST 엔드포인트는 포털 제품에 대한 액세스 포인트입니다. 각 엔드포인트는 REST API의 경로 및 방법과 배포된 스테이지로 구성됩니다. 엔드포인트에는 REST API에 대해 정의한 모든 설명서가 포함되어 있거나 사용자 지정 설명서로 업데이트할 수 있습니다. 제품 REST 엔드포인트를 생성할 때 다음 설정을 구성합니다.
-
제품 REST 엔드포인트의 작업 이름입니다. REST API에 경로와
GET /pets메서드가 있는 경우 포털에서의 이름은/pets입니다. 작업 이름을 사용하여 제품 REST 엔드포인트 이름을Pet summaries로 변경할 수 있습니다. 이는 기존 API에 영향을 주지 않습니다. -
제품 엔드포인트에 대한 사용해 보기 기능입니다. 이렇게 하면 API 소비자가 포털에서 API를 사용해 볼 수 있습니다. 프라이빗 API에 대한 제품 엔드포인트를 생성하는 경우 사용해 보기 기능이
UNAVAILABLE로 설정됩니다. 자세한 내용은 포털에서 API Gateway 제품 REST 엔드포인트에 대해 사용해 보기 활성화 섹션을 참조하세요. -
현재 REST API에 대해 설명서 부분이 정의된 경우, 설명서를 가져오거나 기존 설명서를 재정의하고 GitHub 플래이버 마크다운
을 사용하여 새 제품 수준 설명서를 생성할 수 있습니다. 설명서 재정의는 API Gateway API 설명서 부분으로 다시 전파되지 않습니다. 현재 설명서 부분을 가져오는 경우 API Gateway는 API 전반의 변경 사항을 제품 REST 엔드포인트에 동기화합니다.
제품 REST 엔드포인트 생성
다음 절차에서는 기존 포털 제품에 제품 REST 엔드포인트를 추가하는 방법을 보여 줍니다. 포털 제품과 제품 REST 엔드포인트를 함께 생성하는 방법을 알아보려면 API Gateway에서 포털 제품 생성 섹션을 참조하세요.
제품 포털에 대한 제품 REST 엔드포인트 생성
https://console.aws.amazon.com/apigateway
에서 API Gateway 콘솔에 로그인합니다. 기본 탐색 창에서 포털 제품을 선택합니다.
포털 제품을 선택합니다.
연결된 엔드포인트 탭을 선택한 다음 엔드포인트 추가를 선택합니다.
-
제품 REST 엔드포인트를 선택하려면 API 엔드포인트에서 API를 선택한 다음 스테이지를 선택합니다.
제품 REST 엔드포인트에 엔드포인트를 추가하려면 API 엔드포인트를 선택한 다음 제품에 추가를 선택합니다.
API 엔드포인트가 선택한 API 엔드포인트 목록에 나타납니다.
제출을 선택합니다.
-
이제 제품 REST 엔드포인트 페이지가 초안입니다. 초안 API 참조 페이지를 선택한 다음 제품 REST 엔드포인트 페이지를 선택하여 페이지 콘텐츠를 마무리합니다.
페이지 편집을 선택합니다.
-
기존 API Gateway 설명서를 재정의하려면 설명서 소스에서 설명서 재정의를 켜고 다음을 수행합니다.
콘텐츠 표시에서 재정의 생성을 선택합니다.
작업 이름에 새 작업 이름을 입력합니다.
페이지 본문에 사용자 지정 설명서를 입력합니다.
-
(선택 사항) 엔드포인트에 포털에 표시되는 사용자 지정 엔드포인트를 입력합니다.
-
고객이 포털에서 API를 간접적으로 호출하도록 하려면 사용해 보기 기능을 선택합니다. 자세한 내용은 포털에서 API Gateway 제품 REST 엔드포인트에 대해 사용해 보기 활성화 섹션을 참조하세요.
-
섹션 이름에 이름을 입력하거나 기존 섹션을 선택합니다. 섹션에 제품 REST 엔드포인트를 추가하면 소비자는 게시된 포털에서 콘텐츠를 볼 수 있습니다.
변경 사항 저장을 선택합니다.
새 페이지를 소비자에게 표시하려면 포털을 다시 게시해야 합니다. 자세한 내용은 API Gateway에 포털 게시 섹션을 참조하세요.
