官网:https://swagger.io/
介绍:
- 号称世界上最流行的Api框架;
- RestFul Api文档在线自动生成工具=》Api文档与API定义同步更新;
- 直接运行,可以在线测试API接口;
- 支持多种语言:Java,Php...
SpringBoot集成Swagger2
在项目中使用Swagger需要Springbox(1、swagger2;2、ui )
1、在maven(官网:https://mvnrepository.com/)中查找相关依赖
2、配置Swagger ==> SwaggerConfig
3、运行测试,访问路径 :http://localhost:8080/swagger-ui.html
运行报错 “ Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException ”
原因:版本问题。springboot高版本(2.6.x)和swagger2的低版本(2.9.2)不兼容,将springboot改为低版本如2.1.x,2.4.x等
4、配置swagger信息
5、swagger配置扫描接口
Swagger在生产环境中使用,在发布时不使用?
- 判断是否是生产环境 flag=false
- 注入enable(flag)
6、配置API文档的分组
.groupName("Form")
如何配置多个分组;多个Docket实例即可
总结:
- 我们可以通过Swagger给一些比较难理解的属性或接口,增加注释信息
- 接口文档实时更新
- 可以在线测试
【注意点】在正式发布的时候,一定要关闭Swagger!!!处于安全以及节省内存的考虑!
官网:https://doc.xiaominfo.com/
Knife4j是一款可以提供在线API文档的框架,是基于Swagger2框架实现的。
框架适配
- Spring MVC
- Spring Boot 2.2、2.3、2.4、2.5、2.6、2.7
SpringBoot集成knife4j
1、导入依赖
2、配置Knife4j==> Knife4jConfig
3、接口测试
4、访问路径
默认:http://localhost:8080/doc.html
版本说明:
Knife4j 2.0.6及以上的版本兼容SpringBoot大于等于2.2.x
(2.6.0之后的需要设置)
官网下载地址:https://www.postman.com/downloads/