推广 热搜:   公司  企业  中国  快速    行业  上海  设备  未来 

配置最新 Docker Engine

   日期:2024-12-19     移动:http://fabua.ksxb.net/mobile/quote/4151.html


官网:https://swagger.io/

介绍:

  1. 号称世界上最流行的Api框架;
  2. RestFul Api文档在线自动生成工具=》Api文档与API定义同步更新;
  3. 直接运行,可以在线测试API接口;
  4. 支持多种语言: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在生产环境中使用,在发布时不使用?

  1. 判断是否是生产环境 flag=false
  2. 注入enable(flag)


 6、配置API文档的分组

.groupName("Form")

如何配置多个分组;多个Docket实例即可




总结:

  1. 我们可以通过Swagger给一些比较难理解的属性或接口,增加注释信息
  2. 接口文档实时更新
  3. 可以在线测试

【注意点】在正式发布的时候,一定要关闭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/


本文地址:http://fabua.ksxb.net/quote/4151.html    海之东岸资讯 http://fabua.ksxb.net/ , 查看更多

特别提示:本信息由相关用户自行提供,真实性未证实,仅供参考。请谨慎采用,风险自负。


相关最新动态
推荐最新动态
点击排行
网站首页  |  关于我们  |  联系方式  |  使用协议  |  版权隐私  |  网站地图  |  排名推广  |  广告服务  |  积分换礼  |  网站留言  |  RSS订阅  |  违规举报  |  粤ICP备2023022329号