x-amazon-apigateway-apipropriedade -key-source - Amazon API Gateway

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

x-amazon-apigateway-apipropriedade -key-source

Especifique a origem para receber uma chave de API a fim de controlar os métodos de API que exigem uma chave. Essa propriedade no nível da API é do tipo String.

Especifique a origem da chave de API para as solicitações. Os valores válidos são:

  • HEADER para receber a chave de API do cabeçalho X-API-Key de uma solicitação.

  • AUTHORIZER para receber a chave da API do UsageIdentifierKey de um autorizador do Lambda (anteriormente conhecido como autorizador personalizado).

x-amazon-apigateway-apiexemplo de -chave-fonte

O exemplo a seguir define o cabeçalho X-API-Key como a origem da chave de 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", . . . }