Springboot2.X版本配置Swagger2

Posted 2023-03-09

参考技术A 为什么要引入Swagger?

有过后台开发和前端联调的人都会被接口文档折磨，更新不及时，文档和代码不一致，无法调试，swagger就是为了解决这个问题。

看下swagger官方介绍

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

如此好的利器，怎么在后台框架中快速集成呢？

第一步、添加maven依赖

需要在系统的pom中添加如下依赖：

第二步、添加swagger配置文件

第三步、测试

浏览器输入：http://localhost:8080/swagger-ui.html ，能测试生成的api是否可用。

总结

很好用的开源框架，集成也很简单，建议大家在工程中使用，能够快速开发，减少前后端沟通api的时间成本。