x-amazon-apigateway-documentation 物件 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

x-amazon-apigateway-documentation 物件

定義要匯入API閘道的文件部分。這個對象是一個包含DocumentationPart實例數組的JSON對象。

屬性名稱 類型 描述
documentationParts Array

匯出或匯入的 DocumentationPart 執行個體陣列。

version String

匯出文件部分快照的版本識別符。

x-amazon-apigateway-documentation 例子

下列要開啟的API閘道擴充功能範DocumentationParts例API定義要匯入至API閘道API中或從中匯出的執行個體。

{ ... "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 } ] } }