springboot整合knife4j + swagger(新版本+旧版本)
项目 gitee 仓库地址
https://gitee.com/shao_ming314/springboot-swagger-knie4j
项目说明
两个项目对knife4j 和 swagger 整合 做了最基础的配置 , 开箱即用 .
- springboot-swagger-knife4j-old
该项目是 swagger2+knife4j 低版本 , 其中可以设置请求头 token
访问网址:
swagger: localhost:8080/swagger-ui.html
knife4j : localhost:8080/doc.html
- springboot-swagger-kni4j-new
该项目是 swagger3+knife4j 低版本 , 其中可以设置请求头 token
访问网址:
swagger: localhost:8080/swagger-ui/
knife4j : localhost:8080/doc.html
重点说明:
swagger2和swagger3的项目访问路径是不一样的 , 请注意
包扫描配置
重点代码
.apis(RequestHandlerSelectors.basePackage("com.shaoming.controller"))
为了达到开箱即用的目的 , 我们配置在 上面配置自己的 controller 包路径即可 , 对应的包下 controller 接口都会被扫描到 , 生成在线接口文档
补充说明:
当然生成文档的策略有很多 , 有基于方法上有 @ApiOperation 注解的 controller 方法会生成在线接口文档
版本说明
springboot-swagger-kni4j-new 这个项目支持springboot版本要新 , 我具体没有测试 , 最好2.3.7 以上
springboot-swagger-kni4j-old 这个项目支持比较低版本的 springboot , 比如 2.2.5 版本以下
总结
两个项目都可以开箱即用 , 我们可以根据实际情况集成到自己的项目中.