x-amazon-apigateway-apiproperti -key-source - APIGerbang Amazon

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

x-amazon-apigateway-apiproperti -key-source

Tentukan sumber untuk menerima API kunci ke API metode throttle yang memerlukan kunci. Properti API -level ini adalah String tipe. Untuk informasi selengkapnya tentang mengonfigurasi metode agar memerlukan API kunci, lihatKonfigurasikan metode untuk menggunakan API kunci dengan API definisi Terbuka.

Tentukan sumber API kunci untuk permintaan. Nilai yang valid adalah:

  • HEADERuntuk menerima API kunci dari X-API-Key header permintaan.

  • AUTHORIZERuntuk menerima API kunci dari dari otorisasi Lambda (sebelumnya dikenal sebagai otorisasi khusus). UsageIdentifierKey

x-amazon-apigateway-api-contoh sumber kunci

Contoh berikut menetapkan X-API-Key header sebagai sumber API kunci.

OpenAPI 2.0
{ "swagger" : "2.0", "info" : { "title" : "Test1" }, "schemes" : [ "https" ], "basePath" : "/import", "x-amazon-apigateway-api-key-source" : "HEADER", . . . }
OpenAPI 3.0.1
{ "openapi" : "3.0.1", "info" : { "title" : "Test1" }, "servers" : [ { "url" : "/{basePath}", "variables" : { "basePath" : { "default" : "import" } } } ], "x-amazon-apigateway-api-key-source" : "HEADER", . . . }