API Gateway에서 제품 페이지 생성 - Amazon API Gateway
고려 사항제품 페이지 생성

API Gateway에서 제품 페이지 생성

제품 페이지는 제품 소비자가 제품을 이해하고 사용하는 데 도움이 됩니다. 설명서는 제품 수준에 있으므로 제품을 포함하는 모든 포털에는 이 설명서가 있습니다. API Gateway는 GitHub 플레이버 마크다운으로 작성된 두 가지 유형의 제품 페이지를 지원합니다.

개요 페이지

제품을 생성하면 API Gateway는 제품을 생성할 때 제공한 정보를 기반으로 제품에 대한 개요 페이지를 자동으로 생성합니다. 이 페이지에는 변경할 수 없는 추가 형식이 있습니다. 텍스트를 수정하거나 포털 제품에서 페이지를 제거할 수 있습니다.

사용자 지정 페이지

사용자 지정 페이지는 마크다운으로 작성된 페이지입니다. 이용 약관 또는 제품 사용 방법에 대한 자습서에 이 섹션을 사용할 수 있습니다. 사용자 지정 페이지를 개요 페이지로 변경할 수 있습니다. 사용자 지정 페이지를 개요 페이지로 변경하면 개요 페이지와 일치하도록 페이지 콘텐츠의 형식이 지정됩니다.

고려 사항

다음 고려 사항은 제품 페이지 사용에 영향을 미칠 수 있습니다.

  • 이 설명서는 API 수준이 아니며 메서드, 리소스 또는 요청 파라미터를 포함하지 않습니다. 제품의 API 수준에서 설명서를 수정하는 방법을 알아보려면 API Gateway에서 제품 REST 엔드포인트 업데이트 섹션을 참조하세요.

  • .md 파일을 제품에 직접 업로드할 수 없습니다.

  • 포털 제품의 표시 순서로 페이지 목록을 수정하여 제품 페이지의 순서를 수정할 수 있습니다. 자세한 내용은 API Gateway에서 포털 제품 업데이트 섹션을 참조하세요.

  • 설명서 변경 사항을 적용하려면 제품이 포함된 포털을 다시 게시해야 합니다.

  • 동일한 포털 제품을 사용하는 포털이 여러 개 있는 경우 제품 페이지는 모든 포털에서 동일합니다. 제품 REST 엔드포인트는 동일하지만 제품 페이지는 다르게 하려면 여러 제품을 생성합니다.

제품 페이지 생성

다음 절차는 제품 페이지를 생성하는 방법을 보여 줍니다.

제품 페이지 생성

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

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

  3. 제품을 선택합니다.

  4. 설명서에서 사용자 지정 페이지 생성을 선택합니다.

  5. 페이지 제목에 페이지 제목을 입력합니다.

  6. 본문에 GitHub 플레이버 마크다운을 사용하여 보충 설명서를 입력합니다.

    미리 보기 섹션에는 콘텐츠가 포털에 어떻게 표시되는지 표시됩니다. 최종 시각적 스타일은 포털 설정에 따라 변경될 수 있습니다.

  7. 제품 페이지 생성을 선택합니다.

  8. 이제 제품 페이지가 초안입니다. 설명서 페이지 초안을 선택한 다음 제품 페이지를 선택하여 페이지 콘텐츠를 마무리합니다.

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

  10. 섹션 이름에 이름을 입력하거나 기존 섹션을 선택합니다. 섹션에 제품 페이지를 추가하면 소비자는 게시된 포털에서 콘텐츠를 볼 수 있습니다.

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

새 페이지를 소비자에게 표시하려면 포털을 다시 게시해야 합니다. 자세한 내용은 API Gateway에 포털 게시 섹션을 참조하세요.