Swagger：配置必传的参数（比如token）

程序员无羡

已于 2023-05-04 08:21:34 修改

阅读量1.3k

点赞数

文章标签： java servlet spring swagger

于 2023-05-04 08:20:53 首次发布

本文链接：https://blog.csdn.net/weixin_45427648/article/details/130479890

版权

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Tag;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .tags(new Tag("JsonPropertySerializationController", "JsonProperty相关测试"))
            .select()
            // 扫描包路径
            .apis(RequestHandlerSelectors.basePackage("com.wx.admin.controller"))
            // 显示所有
            .paths(PathSelectors.any())
            // 只显示admin路径下的页面
            // .paths(PathSelectors.regex("/admin/.*"))
            .build();
    }

    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            // 页面标题
            .title("管理后台")
            // 创建人
            .contact(new Contact("程序员无羡", "https://blog.csdn.net/weixin_45427648?spm=1011.2266.3001.5343", "3220416593@qq.com"))
            // 版本号
            .version("1.0")
            // 描述
            .description("API 描述")
            .build()
            // 配置必传的请求头参数
            .globalRequestParameters(
            singletonList(new springfox.documentation.builders.RequestParameterBuilder()
                          // 不能叫Authorization
                          .name("token")
                          .description("token")
                          .in(ParameterType.HEADER)
                          .required(true)
                          .query(q -> q.model(m -> m.scalarModel(ScalarType.STRING)))
                          .build()));
    }
}