互相交流入口地址
整体目录:
【九】springboot整合redis实现启动服务时热点数据保存在全局和缓存
【十三】springboot整合WebService关于传参数
【十五】springboot整合WebSocket实现聊天室
【十六】RabbitMQ基础篇(下载安装并基础使用,内含各种坑问题)
【十九】初学Kafka并实战整合SpringCloudStream进行使用
【二十】springboot整合ElasticSearch实战(万字篇)
【二十三】springboot整合activiti7(1)实战演示篇
【二十四】springboot整合spring事务详解以及实战
【二十五】springboot使用EasyExcel和线程池实现多线程导入Excel数据
【二十六】springboot整合jedis和redisson布隆过滤器处理缓存穿透
【二十八】springboot之threadLocal参数解析器实现session一样保存当前登录功能
介绍:接下来我会把学习阶段学到的框架等知识点进行整合,每一次整合是在前一章的基础上进行的,所以后面的整合不会重复放前面的代码。每次的demo我放在结尾,本次是接着上一章的内容延续的,只增加新增的或者修改的代码。
场景:当在swagger上进行接口测试时,想要新增token参数,如下:
因此,swagger的默认配置是不行的(直接在启动类上面加@EnableSwagger2注解开启)
开启默认配置的swagger:
若想实现以上场景,需要使用自定义swagger配置。
第一步:新增配置类
展示目录结构:
swagger配置文件:
@Configuration
@EnableSwagger2
@Profile("swagger")
public class SwaggerConfig {
/**
* 创建API应用 apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
*
* @return
*/
@Bean
public Docket createRestApi() {
// 选择那些路径和api会生成document
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).pathMapping("/").select()
// 对所有api进行监控
.apis(RequestHandlerSelectors.any())
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).build()
// 配置token
.globalOperationParameters(setHeaderToken());
}
/**
* 配置token
*
* @return
*/
private List<Parameter> setHeaderToken() {
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
tokenPar.name("Authorization").description("token").modelRef(new ModelRef("string")).parameterType("header")
.required(false).build();
pars.add(tokenPar.build());
return pars;
}
/**
* 创建该API的基本信息(这些基本信息会展现在文档页面中)
*
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("测试接口文档").description("测试接口文档").version("1.0").build();
}
}
-
@Configuration:用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描,并用于构建bean定义,初始化Spring容器,简而言之就是在Spring启动时会将该类识别成一个配置类。
-
@EnableSwagger2:开启swagger,此处也需要使用。
到此处即可完成使用自定义的swagger,若有其他需求修改该配置类即可,另外此处另外提到一个注解Profile,此处可以不使用,在实际开发中可能存在多个环境,测试环境,正式环境等,可能需要使用不同的配置,此时可以使用Profile注解。
@Profile("swagger"):指定组件在哪个环境的情况下才能被注册到容器中,不指定,任何环境下都能注册这个组件。
实际使用:
yml配置文件在开发时可能存在多个,因此可以指定具体哪一个环境可以开启该配置,如下图,在想要开启该配置的环境的yml文件里加上如下代码即可。
active后面的值是配置文件里面profile注解里面的参数值。profile注解的具体使用就不展开了。
到此完毕,接下来会继续更新加强整合,尽情期待。
访问地址:http://localhost:8082/swagger-ui.html或者http://localhost:8082/doc.html