springboot2整合swagger2配置(加头消息，如token)

最新推荐文章于 2025-07-07 18:42:17 发布

CodeMonkey陈

最新推荐文章于 2025-07-07 18:42:17 发布

阅读量171

点赞数 3

CC 4.0 BY-SA版权

文章标签： windows 服务器运维

本文链接：https://blog.csdn.net/qq_29945661/article/details/145735828

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket accessToken() {
        //添加header参数
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        ticketPar.name("access-token").description("user token")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的ticket参数非必填，传空也可以
        pars.add(ticketPar.build());    //根据每个方法名也知道当前方法在设置什么参数

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("api")// 定义组
                .select() // 选择那些路径和 api 会生成 document
                .apis(RequestHandlerSelectors.basePackage("com.oceandata.build_civilized_city.controller")) // 拦截的包路径
                .paths(PathSelectors.regex("/*/.*"))// 拦截的接口路径
                .build() // 创建
                .globalOperationParameters(pars)//添加head参数
                .apiInfo(apiInfo()); // 配置说明
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()//
                .title("Oceandata Java Framework API")// 标题
                .description("测试系统WebApi")// 描述
                .termsOfServiceUrl("http://www.test.com.cn")//
                .version("1.0")// 版本
                .build();
    }
}