ApiDefinition

Dokumen OpenAPI yang menentukan API.

Sintaks

Untuk mendeklarasikan entitas ini di templat AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

  Bucket: String
  Key: String
  Version: String

Properti

Bucket

Nama bucket Amazon S3 tempat file OpenAPI disimpan.

Tipe: String

Wajib: Ya

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti Bucket dari tipe data AWS::ApiGateway::RestApi S3Location.

Key

Kunci Amazon S3 dari file OpenAPI.

Tipe: String

Wajib: Ya

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti Key dari tipe data AWS::ApiGateway::RestApi S3Location.

Version

Untuk objek berversi, versi file OpenAPI.

Tipe: String

Wajib: Tidak

Kompatibilitas AWS CloudFormation: Properti ini diteruskan langsung ke properti Version dari tipe data AWS::ApiGateway::RestApi S3Location.

Contoh-contoh

Contoh Uri Ketentuan

Contoh ketentuan API

YAML

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