x-amazon-apigateway-apiproperti -key-source

Tentukan sumber untuk menerima kunci API untuk membatasi metode API yang memerlukan kunci. Properti API-level ini adalah tipe. String Untuk informasi selengkapnya tentang mengonfigurasi metode agar 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 pengotorisasi Lambda (sebelumnya dikenal sebagai otorisasi khusus).

x-amazon-apigateway-api-contoh sumber kunci

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