如何使用Swagger在API网关上全局设置API密钥安全

Question

我正在尝试将openapi/swagger文件导入api网关，但无法按预期获得安全设置。我希望所有路径都需要一个api密钥。

导入后在控制台中设置它所需的api密钥是可行的，但这种解决方案是不可取的，同样可行的是在每个路径中单独设置安全字段，但我正在寻找全局解决方案。

当我尝试导入文件时，我会收到以下警告：

Your API was not imported due to errors in the Swagger file.

    Method 'GET' on resource '/' specified security,
    but no custom authorizers were created and the extension
    x-amazon-apigateway-auth was not set.
    This method will be not be secured. 

看起来，我要么需要一个lambda作为api密钥的自定义授权器（我不熟悉授权器，但如果我在控制台中设置所需的api密钥时不需要，这似乎没有意义）；或者我需要用这个神秘的x-amazon-apigateway-auth做些什么，我找不到文档（亚马逊在这里记录了所有其他openapi扩展）。

一个迷你示例如下：

openapi: 3.0.1
info:
  title: test
  version: 0
servers:
- url: "/"
security:
  - ApiKey: []
paths:
  "/":
    get:
      # if I copy the security part into here things work 
      responses:
        '204':
          description: no content
      x-amazon-apigateway-integration:
        httpMethod: GET
        type: http
        uri: https://httpstat.us/204
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header
x-amazon-apigateway-api-key-source: HEADER

由于api密钥安全性是在根级别设置的，这向我表明所有路径都应该使用api密钥（除非被单个路径覆盖），实际发生的是上述警告，并且在导入时不需要api密钥。

Answer 1

在我写这个答案的时候，根据他们的留档，AWS API网关不支持在根级别设置安全性。

API网关不使用OpenAPI规范中定义的根级别安全性。因此，需要在操作级别定义安全性才能适当应用。