x-amazon-apigateway-documentation 객체
API Gateway로 가져올 설명서 부분을 정의합니다. 이 객체는 DocumentationPart 인스턴스의 어레이를 포함하는 JSON 객체입니다.
속성 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 속성 이름 | 유형 | 설명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentationParts |
Array |
내보내거나 가져온 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version |
String |
내보낸 설명서 부분의 스냅샷의 버전 ID입니다. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
x-amazon-apigateway-documentation 예제
OpenAPI에 대한 API Gateway 확장의 다음 예에서는 API Gateway의 API에서 내보내거나 가져올 DocumentationParts 인스턴스를 정의합니다.
{ ... "x-amazon-apigateway-documentation": { "version": "1.0.3", "documentationParts": [ { "location": { "type": "API" }, "properties": { "description": "API description", "info": { "description": "API info description 4", "version": "API info version 3" } } }, { … // Another DocumentationPart instance } ] } }
