如何为 swagger 添加通用参数 api

Question

我的项目中有很多带有此类注释的控制器

    @ApiOperation(value = "description")
    @RequestMapping(value = "/{param1}", method = RequestMethod.POST)
    public @ResponseBody Response<Map<String, Object>> someMethod(
       @ApiParam(name = "param1", value = "about param1", required = true)
       @PathVariable("param1") int param1,

       @ApiParam(name = "param2", value = "about param2", required = false, defaultValue = "default)
       @RequestParam(value = "param2", defaultValue = "default") String param2
    ){
           // ..
    }

几乎每个方法都接受像 access_token 这样的公共参数。如果我们在所有方法中添加关于它的描述，这将是不好的解决方案。也许还有其他解决方案？

我发现我可以像这里 https://github.com/OAI/OpenAPI-Specification/blob/master/fixtures/v2.0/json/resources/reusableParameters.json 这样的配置定义 json 文件，但据我所知，我可以使用 json 或注释。或者也许我可以以某种方式将它们组合起来？

Answer 1

如果有人会搜索这样的东西。我找到了下一个解决方案。在项目中我们这样配置swagger

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(commonParameters())
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo(/* params here */);
        return apiInfo;
    }


    private List<Parameter> commonParameters(){
        List<Parameter> parameters = new ArrayList<Parameter>();
        parameters.add(new ParameterBuilder()
                .name("access_token")
                .description("token for authorization")
                .modelRef(new ModelRef("string"))
                .parameterType("query")
                .required(false)
                .build());

        return parameters;
    }
}

您应该调用 globalOperationParameters 方法并向其传递全局参数列表（我在 commonParameters 方法中创建它）。

我在这里找到的解决方案http://springfox.github.io/springfox/docs/current/

就这些。

如何为 swagger 添加通用参数 api

How add a common parameter for swagger api

json

restful-architecture

swagger-ui