x-amazon-apigateway-api-鍵源屬性 - Amazon API Gateway
x-amazon-apigateway-api-關鍵源示例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

x-amazon-apigateway-api-鍵源屬性

指定要接收API金鑰的來源，以限制需要金鑰的API方法。此API層級屬性是一String種類型。若要取得有關將方法配置為需要API金鑰的詳細資訊，請參閱〈〉設定方法以使用具有 OpenAPI 定義的API金鑰。

指定要求的API金鑰來源。有效的 值如下：

  • HEADER用於從請求的X-API-Key頭接收API密鑰。

  • AUTHORIZER用於從 Lambda 授權者 (以前稱為自訂授權者) 接收API金鑰。UsageIdentifierKey

x-amazon-apigateway-api-關鍵源示例

下列範例會將標X-API-Key頭設定為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",
   .
   .
   .
}