REST API 문서화 - Amazon API Gateway

REST API 문서화

고객이 API를 이해하고 사용할 수 있도록 API를 문서화해야 합니다. API를 문서화하는 데 도움이 되도록 API Gateway에서는 개별 API 엔터티에 대한 도움말 콘텐츠를 API 개발 프로세스의 핵심 부분으로 추가하고 업데이트할 수 있습니다. API Gateway에서는 소스 콘텐츠가 저장되며 다양한 버전의 설명서를 보관할 수 있습니다. 설명서 버전을 API 단계와 연결하고, 단계별 설명서 스냅샷을 외부 OpenAPI 파일로 내보내고, 이 파일을 설명서 간행물로 배포할 수 있습니다.

API를 문서화하려면 API Gateway REST API를 호출하거나, API Gateway용 AWS SDK 또는 AWS CLI 중 하나를 사용하거나, API Gateway 콘솔을 사용할 수 있습니다. 또한 외부 OpenAPI 파일에 정의된 설명서 부분을 가져오거나 내보낼 수 있습니다. API를 문서화하는 방법을 설명하기 전에 API 설명서가 API Gateway에 표시되는 방법을 살펴봅니다.