게시된 날짜: Dec 1, 2016
이제 Amazon API Gateway를 사용하여 구축한 API의 메서드 및 리소스에 문서를 추가할 수 있어 API 고객이 API를 쉽게 이해할 수 있게 되었습니다. API Gateway 콘솔, CLI 및 SDK를 사용하여 직접 API에 대한 설명서를 추가하거나 API에 대한 Swagger 정의 내 설명서 태그를 사용하여 지정할 수 있습니다. 또한 API의 공통 영역에서 설명서를 재사용할 수도 있습니다. 예를 들어, 표준 오류 설명서를 한 번만 작성한 후에, 실제 콘텐츠를 복제하지 않고 여러 API 응답에서 사용할 수 있으므로, 보다 빠르게 API에 대한 설명서를 작성하고 중복된 문자열에서 발생할 수 있는 "복사-붙여넣기" 오류를 방지할 수 있습니다. API 단계의 일부로 설명서가 게시되면 Swagger 내보내기 기능을 사용하여 내보낸 후 개발자 포털에서 사용할 수 있습니다.
API Gateway에서는 API 정의 및 API 설명서에 대한 독립된 워크플로를 제공합니다. 이를 통해 API 개발자와 기술 작성자는 동시에 작업하며, 콘솔, CLI 및 SDK를 사용하여 개별적으로 자신의 Swagger를 가져올 수 있습니다.
자세한 내용은 API Gateway API 설명서를 참조하십시오.