AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::DocumentationPart

AWS::ApiGateway::DocumentationPart 资源可创建 Amazon API Gateway API 实体的文档部件。有关更多信息,请参阅 API 网关 开发人员指南 中的 API Gateway 中的 API 文档表示形式

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::ApiGateway::DocumentationPart", "Properties" : { "Location" : Location, "Properties" : String, "RestApiId" : String } }

YAML

Type: "AWS::ApiGateway::DocumentationPart" Properties: Location: Location Properties: String RestApiId: String

属性

注意

有关每个属性的更多信息,包括约束和有效值,请参阅 Amazon API Gateway REST API 参考 中的 DocumentationPart

Location

文档适用于的 API 实体的位置。

必需:是

类型Amazon API Gateway DocumentationPart 位置

更新要求替换

Properties

目标 API 实体的文档内容映射。

必需:是

类型:字符串

更新要求无需中断

RestApiId

目标 API 实体的标识符。

必需:是

类型:字符串

更新要求替换

返回值

Ref

当您将 AWS::ApiGateway::DocumentationPart 资源的逻辑 ID 传递给内部函数 Ref 函数时,此函数返回文档部件的 ID,例如 abc123

有关使用 Ref 功能的更多信息,请参阅参考

示例

以下示例将 API 实体的文档部件与文档版本相关联。

JSON

{ "Parameters": { "apiName": { "Type": "String" }, "description": { "Type": "String" }, "version": { "Type": "String" }, "type": { "Type": "String" }, "property": { "Type": "String" } }, "Resources": { "RestApi": { "Type": "AWS::ApiGateway::RestApi", "Properties": { "Name": { "Ref": "apiName" } } }, "DocumentationPart": { "Type": "AWS::ApiGateway::DocumentationPart", "Properties": { "Location": { "Type": { "Ref": "type" } }, "RestApiId": { "Ref": "RestApi" }, "Property": { "Ref": "property" } } }, "DocumentationVersion": { "Type": "AWS::ApiGateway::DocumentationVersion", "Properties": { "Description": { "Ref": "description" }, "DocumentationVersion": { "Ref": "version" }, "RestApiId": { "Ref": "RestApi" } }, "DependsOn": "DocumentationPart" } } }

YAML

Parameters: apiName: Type: String description: Type: String version: Type: String type: Type: String property: Type: String Resources: RestApi: Type: 'AWS::ApiGateway::RestApi' Properties: Name: !Ref apiName DocumentationPart: Type: 'AWS::ApiGateway::DocumentationPart' Properties: Location: Type: !Ref type RestApiId: !Ref RestApi Property: !Ref property DocumentationVersion: Type: 'AWS::ApiGateway::DocumentationVersion' Properties: Description: !Ref description DocumentationVersion: !Ref version RestApiId: !Ref RestApi DependsOn: DocumentationPart

本页内容: