View a markdown version of this page

properti x-amazon-apigateway-api-key-source - Amazon API Gateway
contoh x-amazon-apigateway-api-key-source

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

properti x-amazon-apigateway-api-key-source

Tentukan sumber untuk menerima kunci API untuk membatasi metode API yang memerlukan kunci. Pro API-level perti ini adalah String tipe. Untuk informasi selengkapnya tentang mengonfigurasi metode untuk memerlukan kunci API, lihatKonfigurasikan metode untuk menggunakan kunci API dengan definisi OpenAPI.

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

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

  • AUTHORIZERuntuk menerima kunci API dari UsageIdentifierKey dari otorizer Lambda (sebelumnya dikenal sebagai otorizer kustom).

contoh x-amazon-apigateway-api-key-source

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

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",
   .
   .
   .
}