用于在AWS API网关上支持API键的Spring Boot Swagger注释

Question

我正在尝试设置一个AWS API网关，该网关需要在任何请求的标头中使用API密钥。我设置了swagger来生成json定义，AWS很好地导入了它。但是，当我尝试添加API密钥安全定义时，Amazon拒绝了我的swagger API文档，错误如下：

由于Swagger文件中的错误，您的API未导入。API密钥安全定义“api_key”有意外的名称或位置。忽略。

我想我做错了。。。因此，我尝试了这方面的几种变化。

给定使用springfox创建的Spring Boot配置：

 @Bean
    public Docket swaggerSpringMvcPlugin() {

    List<ApiKey> securitySchemes = new ArrayList<>();
    ApiKey apiKey = new ApiKey("apiKey", "api_key", "header");
    list.add(apiKey);
    //the above is probably where i'm missing something

        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .securitySchemes(securitySchemes)
                .select()
                .paths(PathSelectors.regex("/api/swaggertest"))
                .build();
    }

上述api定义如下：

@RestController
public class SwaggerTestController {

      @ApiOperation(notes = "my notes", value = "test", nickname = "testNickname",
                tags = {"tests"}, authorizations = {@Authorization(value="api_key")} )
        @ApiResponses({
                @ApiResponse(code = 200, message = "Nice!", response = Swag.class)
        })
        @RequestMapping(value = "/api/swaggertest", method = RequestMethod.GET, produces = "application/json")
        public ResponseEntity<Swag> getSwag() throws Exception {


                return ResponseEntity.ok().body(new Swag());

        }
    }

当我运行我的应用程序时，api-docs会产生（我删除了一些部分以保持它更小）：

{
swagger: "2.0",

host: "localhost:4014",
basePath: "/",
tags: [
{
    name: "swagger-test-controller",
    description: "Swagger Test Controller"
}
],
paths: {
    /api/swaggertest: {
get: {
    tags: [
    "tests"
],
summary: "test",
description: "my notes",
operationId: "testNickname",
consumes: [
    "application/json"
],
produces: [
    "application/json"
],
responses: {
    200: {
    description: "Nice!",
    schema: {
        $ref: "#/definitions/Swag"
    }
    }
   },
    security: [
    {
    api_key: [ ]
    }
    ]
    }
   }
},
securityDefinitions: {
    api_key: {
    type: "apiKey",
    name: "api_key",
    in: "header"
}
},
definitions: {
    Swag: {
    type: "object",
    properties: {
    foo: {
        type: "string"
}

} } }

如果有人能帮我指出如何添加api密钥支持，我将不胜感激。

Answer 1

安全定义应如下所示，引用<代码>

"<any_name>" : {
  "type" : "apiKey",
  "name" : "x-api-key",
  "in" : "header"
},