Api - AWS Serverless Application Model
SintaksPropertiContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Api

Objek yang menggambarkan tipe sumber peristiwa Api. Jika sumber daya AWS::Serverless::Api didefinisikan, nilai jalur dan metode harus sesuai dengan operasi dalam ketentuan OpenAPI API.

Jika AWS::Serverless::Api tidak ditentukan, input dan output fungsi adalah representasi dari permintaan HTTP dan respons HTTP.

Misalnya, menggunakan JavaScript API, kode status dan isi respons dapat dikontrol dengan mengembalikan objek dengan kunci StatusCode dan body.

Sintaks

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

Properti

Auth

Konfigurasi auth untuk Api+Path+Metode tertentu ini.

Berguna untuk membatalkan config auth pengaturan DefaultAuthorizer API pada jalur individu ketika DefaultAuthorizer tidak ditentukan atau membatalkan pengaturan ApiKeyRequired default.

Jenis: ApiFunctionAuth

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Method

Metode HTTP yang membuat fungsi ini dipanggil.

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Path

Jalur Uri yang membuat fungsi ini dipanggil. Harus dimulai dengan /.

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

RequestModel

Permintaan model yang akan digunakan untuk Api+Path+Metode tertentu ini. Ini harus merujuk nama model yang ditentukan dalam bagian Models dari sumber daya AWS::Serverless::Api.

Jenis: RequestModel

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

RequestParameters

Konfigurasi parameter permintaan untuk Api+Path+Metode tertentu ini. Semua nama parameter harus dimulai dengan method.request dan harus terbatas pada method.request.header, method.request.querystring, atau method.request.path.

Daftar dapat berisi string nama parameter dan RequestParameterobjek. Untuk string, Caching properti Required and akan default kefalse.

Jenis: Daftar [String | RequestParameter]

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

RestApiId

Pengidentifikasi RestApi sumber daya, yang harus berisi operasi dengan jalur dan metode yang diberikan. Biasanya, ini diatur untuk merujuk sumber daya AWS::Serverless::Api yang ditentukan dalam templat ini.

Jika Anda tidak mendefinisikan properti ini, AWS SAM buat AWS::Serverless::Api sumber daya default menggunakan OpenApi dokumen yang dihasilkan. Sumber daya tersebut berisi penyatuan dari semua jalur dan metode yang ditentukan oleh peristiwa Api dalam templat yang sama yang tidak menentukan RestApiId.

Ini tidak dapat merujuk sumber daya AWS::Serverless::Api yang ditentukan dalam templat lain.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

TimeoutInMillis

Waktu habis khusus antara 50 dan 29.000 milidetik.

catatan

Saat Anda menentukan properti ini, AWS SAM memodifikasi definisi OpenAPI Anda. Definisi OpenAPI harus ditentukan sebaris menggunakan properti. DefinitionBody

Tipe: Integer

Wajib: Tidak

Default: 29.000 milidetik atau 29 detik

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Contoh

Contoh basic

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization
        - method.request.querystring.keyword:
            Required: true
            Caching: false