기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
REST API 문서화
고객이 API를 이해하고 사용할 수 있도록 API를 문서화해야 합니다. API를 문서화하는 데 도움이 되도록 API Gateway에서는 개별 API 엔터티에 대한 도움말 콘텐츠를 API 개발 프로세스의 핵심 부분으로 추가하고 업데이트할 수 있습니다. API Gateway에서는 소스 콘텐츠가 저장되며 다양한 버전의 설명서를 보관할 수 있습니다. 설명서 버전을 API 단계와 연결하고, 단계별 설명서 스냅샷을 외부 OpenAPI 파일로 내보내고, 이 파일을 설명서 간행물로 배포할 수 있습니다.
API를 문서화하려면 API Gateway REST API를 호출하거나, API Gateway용 AWS SDK
개발자 포털을 사용하면 API 설명서를 개발자와 공유할 수 있습니다. 예제를 보려면 AWS 파트너 네트워크(APN) 블로그에서 Integrating ReadMe with API Gateway to Keep Your Developer Hub Up to Date