Swagger2Config 修改增加ui页面增加token

最新推荐文章于 2025-10-06 16:55:39 发布

原创最新推荐文章于 2025-10-06 16:55:39 发布 · 223 阅读

0 ·

CC 4.0 BY-SA版权

该篇博客详细介绍了如何利用Spring Boot的Swagger2来创建RESTful API的接口文档，并展示了如何配置安全方案，包括设置全局的Header Token参数，确保在使用Swagger进行API测试时能正确携带授权信息。

@Bean
public Docket createRestApi() {

	return new Docket(DocumentationType.SWAGGER_2)
		.apiInfo(apiInfo())
		.select()//此包路径下的类，才生成接口文档
		.apis(RequestHandlerSelectors.basePackage("org.jeecg.modules"))//加了ApiOperation注解的类，才生成接口文档
	        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
		.paths(PathSelectors.any())
		.build()
		.securitySchemes(Collections.singletonList(securityScheme()))
	        .globalOperationParameters(setHeaderToken());//打开后swagger 请求需要带token

}

private List<Parameter> setHeaderToken() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name(DefContants.X_ACCESS_TOKEN).description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return pars;
}