Swagger简介

说起Swagger，真是后台API开发的利器，在没有前端页面的情况下，很方便的就可以进行后台逻辑的测试。一般来说，在spring mvc工程中使用了Swagger，它会自动扫描controller中的参数，在Swagger的页面中进行显示。例如有如下代码：

    @GetMapping("bar")
    public String bar(String bar) {
        return bar;
    }

则会显示如下页面：

在页面中填入参数即可向后台发送请求了。

Swagger全局参数

但是在开发过程中，存在着统一添加参数的情况，例如所有的后台参数都添加token以便进行权限验证，而token并没有出现在controller的方法签名中，这时候在Swagger界面中是没有token的，此时需要在Swagger中添加全局参数。

@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage(Application.class.getPackage().getName()))
                .build()
                .globalOperationParameters(Collections.singletonList(
                        new ParameterBuilder()
                                .name("token")
                                .description("token")
                                .modelRef(new ModelRef("string"))
                                .parameterType("header")
                                .required(true)
                                .build()
                ));
    }
}

注意到在最后调用了globalOperationParameters方法，表示添加了一个全局的参数，名字是token，类型是string，在header中出现，并且是必须的。

这样Swagger UI界面中会自动出现token参数。