ApiDefinition

Um documento da OpenAPI que define a API.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

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

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade Bucket do tipo de dados AWS::ApiGateway::RestApi S3Location.

Key

A chave do Amazon S3 do arquivo OpenAPI.

Tipo: string

Obrigatório: Sim

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade Key do tipo de dados AWS::ApiGateway::RestApi S3Location.

Version

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

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade Version do tipo de dados AWS::ApiGateway::RestApi S3Location.

Exemplos

Exemplo de definição de Uri

Exemplo de definição de API

YAML

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