当前位置: 首页 > 后端技术 > Java

只需要一个依赖,就可以给Swagger换上新的皮肤,简单又爽!

时间:2023-04-02 09:24:59 Java

Swagger是一款非常流行的API文档生成工具,相信很多小伙伴都在使用。Swagger最方便的地方就是只要你的项目集成了它,一启动就可以生成最新版本的文档,并且可以在线调试。但是Swagger的接口调试功能确实有很多缺点,比如对JSON的支持不是很友好。今天我们使用Knife4j对其进行增强,使用SpringDoc提供的Swagger实现库,希望对大家有所帮助!SpringBoot实战电商项目商城(50k+star)地址:https://github.com/macrozheng/mall说说Swagger的Java库首先说说Java中两个流行的Swagger实现库,对比一下哪个更好使用。SpringFoxSpringFox是一个老式的Swagger实现库。它在Github上标有5.6K+星。我相信很多小伙伴项目中都集成了这个库。但是实现库自两年前发布3.0.0版本后一直没有发布版本。而如果你在SpringBoot2.6.x以上使用,你会发现很多问题需要自己解决。具体可以参考升级SpringBoot2.6.x后,Swagger不能再用了!.SpringDocSpringDoc是最近才流行起来的Swagger实现库。它在Github上标有2K+星。版本更新还是很快的,维护更新有保障。之前写过一篇SpringDoc教程,大家可以参考一下。SpringDoc的功能还是挺强大的。不仅支持SpringWebMvc项目,还支持SpringWebFlux项目。选择哪一个?如果你在你的项目中集成了SpringFox并广泛使用它,你仍然应该使用SpringFox。毕竟迁移也是需要成本的。如果你的项目是新项目,目前处于技术选型阶段,可以考虑使用SpringDoc,毕竟更新维护更有保障。将SpringDoc与Knife4j结合使用Knife4j是一个SwaggerUI增强库。以前一直以为它只支持SpringFox。最近发现它也支持SpringDoc。Knife4j可以无缝支持SpringDoc,只需要添加一个依赖,无需修改任何用法,非常方便!这里我们还是使用SpringDoc来使用教程中的mall-tiny-springdocDemo,先在pom.xml中添加Knife4j相关依赖;com.github.xiaoyminknife4j-springdoc-ui3.0.3然后启动项目,访问Knife4j默认的接口文档地址:http://localhost:8088/doc.html我们找到一个需要提交JSON格式请求参数的接口进行调试,发现对于JSON格式的参数,Knife4j提供格式验证功能;然后找一个返回比较长的数据的接口进行调试,Knife4j提供了数据折叠的功能,这两个功能确实是我们比较需要的。在Knife4j微服务方案更新之前,发布了一个微服务聚合SwaggerAPI文档方案,也是用到了Knife4j。最近更新了支持最新版的SpringCloud。这里我们再说说这个解决方案。实现原理我们理想的方案应该是这样的。网关作为API文档的统一入口。网关聚合了所有微服务的文档,访问其他服务API文档是通过在网关处切换实现的。相关服务划分:micro-knife4j-gateway:网关服务,作为微服务API文档的访问入口,聚合所有API文档,需要导入文档前端UI包;micro-knife4j-user:用户服务,普通API服务,无需导入Document前端UI包;micro-knife4j-order:订单服务,普通API服务,无需引入文档前端UI包。项目地址https://github.com/macrozheng...总结和Knife4j一样,没有改变Swagger原来的用途,而且可以增强Swagger功能的库确实不错。如果再多一些这样的换肤实现库,Swagger的体验应该会更好!项目源码地址https://github.com/macrozheng...