HttpApiDefinition

一個 OpenAPI 文檔定義的 API。

語法

若要在 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: mybucket-name
  Key: mykey-name
  Version: 121212