Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

x-amazon-apigateway-documentation 对象

定义要导入到 API Gateway 中的文档部分。此对象是一个包含 DocumentationPart 示例数组的 JSON 对象。

属性

属性名称 类型 描述
documentationParts Array

导出或导入的 DocumentationPart 实例数组。

version String

导出文档部分的快照的版本标识符。

x-amazon-apigateway-documentation 示例

以下基于 Swagger 的 API Gateway 扩展示例将 DocumentationParts 实例定义为从 API Gateway 中的 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 } ] } }