HttpApiDefinition - AWS Serverless Application Model
语法属性示例

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

HttpApiDefinition

定义 API 的 OpenAPI 文档。

语法

要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。

YAML

  Bucket: String
  Key: String
  Version: String

属性

Bucket

存储了 OpenAPI 文件的 Amazon S3 桶的名称。

类型：字符串

必需：是

AWS CloudFormation 兼容性：此属性直接传递给AWS::ApiGatewayV2::ApiBodyS3Location数据类型的Bucket属性。

Key

OpenAPI 文件的 Amazon S3 密钥。

类型：字符串

必需：是

AWS CloudFormation 兼容性：此属性直接传递给AWS::ApiGatewayV2::ApiBodyS3Location数据类型的Key属性。

Version

对于受版本控制的对象，是 OpenAPI 文件的版本。

类型：字符串

必需：否

AWS CloudFormation 兼容性：此属性直接传递给AWS::ApiGatewayV2::ApiBodyS3Location数据类型的Version属性。

示例

定义 Uri 示例

API 定义示例

YAML

DefinitionUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212