HttpApiDefinition - AWS Serverless Application Model
SintassiProprietàEsempi

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

HttpApiDefinition

Un documento OpenAPI che definisce l'API.

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la seguente sintassi.

YAML

  Bucket: String
  Key: String
  Version: String

Proprietà

Bucket

Il nome del bucket Amazon S3 in cui è archiviato il file OpenAPI.

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alBucketproprietà delAWS::ApiGatewayV2::Api BodyS3Locationtipo di dati.

Key

La chiave Amazon S3 del file OpenAPI.

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alKeyproprietà delAWS::ApiGatewayV2::Api BodyS3Locationtipo di dati.

Version

Per gli oggetti con versione, la versione del file OpenAPI.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alVersionproprietà delAWS::ApiGatewayV2::Api BodyS3Locationtipo di dati.

Esempi

Esempio di definizione Uri

Esempio di definizione API

YAML

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