HttpApiDefinition

Um documento da OpenAPI que define a API.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

  Bucket: String
  Key: String
  Version: String

Propriedades

Bucket

O nome do bucket do Amazon S3 no qual o arquivo do OpenAPI está armazenado.

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Bucket propriedade do tipo de AWS::ApiGatewayV2::Api BodyS3Location dados.

Key

A chave do Amazon S3 do arquivo OpenAPI.

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Key propriedade do tipo de AWS::ApiGatewayV2::Api BodyS3Location dados.

Version

Para objetos com controle de versão, a versão do arquivo OpenAPI.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Version propriedade do tipo de AWS::ApiGatewayV2::Api BodyS3Location dados.

Exemplos

Exemplo de definição de Uri

Exemplo de definição de API

YAML

DefinitionUri:
  Bucket: mybucket-name
  Key: mykey-name
  Version: 121212