springboot项目集成swagger-ui及可能遇到问题


很多开发人员都不喜欢写文档!接口太多了,变化太多了,改完代码还要改文档。流程不规范的团队,经常会出现这样的情况:有时候接口代码变了,文档没有及时更新,前端开发人员不知道;有时候是后台开发人员直接与前端开发人员私下商量一致,直接更新代码不更新文档,久而久之,文档就是去了作用,成了摆设。另外,接口测试工作要借助类似Postman的第三方工具。但事与人违,文档是交流沟通的媒介,文档是项目验收的必备材料,文档是知识和经验的积累!每一个开发人员无法避免的一项工作,就是写文档!
那么,有没有什么工具能够帮助我们自动生成接口文档呢?Swagger就可以帮助我们解决以上困惑。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。在Spring Boot项目中,可以将文件的方法、参数和模型紧密集成到服务器端的代码,始终保持同步。Swagger作用主要包括两点:接口文档在线自动生成和功能测试。

下面就是springboot项目集成swagger的步骤:

1,pom文件添加依赖

<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.9.2</version>
</dependency>
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.9.2</version>
</dependency>

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.8.1</version
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值