本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
x-amazon-apigateway-documentation 物件
定義要匯入 API Gateway 的文件部分。這個物件是包含 DocumentationPart 執行個體陣列的 JSON 物件。
屬性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 屬性名稱 | 類型 | 描述 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentationParts |
Array |
匯出或匯入的 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version |
String |
匯出文件部分快照的版本識別符。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 } ] } }
