这些年我用过的 API 文档工具,个个是精品!
这些年用过不少API文档工具,也写过不少相关的文章,我发现
哪种API文档工具更好用
一直都是大家比较关心的话题。今天整理了下我曾经用过的7种API文档工具,每个都有详细的使用教程,肯定有你中意的一种!
Swagger
Swagger是一款非常流行的API文档工具,它能帮助你简化API文档的开发,极大提高开发效率,之前在mall
项目中就是使用的它。
我们一般将Swagger和SpringBoot结合使用,使用的是Springfox给我们提供的工具。使用该工具可以根据注解自动生成API文档,并且可以在生成的文档上进行接口调试。
由于API文档随着项目的启动而更新,所以API文档的实时性很有保证!Springfox官方还给我们提供了Starter,整合非常方便。
项目地址:https://github.com/springfox/springfox
Knife4j
虽然Swagger已经非常好用,但是存在界面不够美观,API调试功能弱的缺点,比如请求参数没有校验,返回一堆JSON数据时无法折叠这类问题。于是在Swagger的基础上,就有了一些增强工具的出现。
Knife4j是springfox-swagger的增强UI实现,为Java开发者在使用Swagger的时候,提供了简洁、强大的接口文档体验。Knife4j完全遵循了springfox-swagger中的使用方式,并在此基础上做了增强功能,如果你用过Swagger,你就可以无缝切换到Knife4j。
使用Knife4j就好像给Swagger换了个新皮肤,瞬间就高大上了。
如果你的项目是微服务项目的话,使用Knife4j可以聚合所有服务的文档。
项目地址:https://github.com/xiaoymin/swagger-bootstrap-ui
Postman
由于Swagger的接口调试能力比较弱,使用Postman来调试也不失为一个好方案。
Postman是一款API接口调试工具,使用它可以很方便的对接口进行测试,并且后端人员可以将自己的调试结果导出,方便前端人员调试。
当然在Postman中查看API文档也是可以的,只是功能有点偏弱,所以才有了Swagger+Postman这种流行组合。
官方网站:https://www.postman.com/
YApi
除了Knife4j这类给Swagger做增强的工具,还有一类工具本身就具有API文档管理的功能,可独立部署并且可以对接Swagger,功能更加强大,也可以称之为API文档管理平台。
YApi正是这样一种工具,YApi是高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。YApi在Github上已累计获得了18K+Star,具有优秀的交互体验,YApi不仅提供了常用的接口管理功能,还提供了权限管理、Mock数据、Swagger数据导入等功能,总之功能很强大!
项目地址:https://github.com/YMFE/yapi
smart-doc
Swagger需要通过它自己的注解来实现API文档的生成,代码入侵性有点强,如果你想零入侵的话,不妨试试smart-doc
。
smart-doc
是一款API文档生成工具,无需多余操作,只要你规范地写好代码注释,就能生成API文档。同时能直接生成Postman调试文件,一键导入Postman即可调试,非常好用!
smart-doc
和Swagger的接口调试能力一样,都比较弱,也得配合Postman来使用 。
项目地址:https://gitee.com/smart-doc-team/smart-doc
Torna
又一款可独立部署的API文档管理工具,可以搭建API文档管理平台。不仅支持Swagger导入、还支持Postman和OpenApi等导入。
Torna是一套企业级接口文档解决方案,可以配合Swagger使用 。它具有如下功能:
文档管理:支持接口文档增删改查、接口调试、字典管理及导入导出功能; 权限管理:支持接口文档的权限管理,同时有访客、开发者、管理员三种角色; 双模式:独创的双模式,管理模式可以用来编辑文档内容,浏览模式纯粹查阅文档,界面无其它元素干扰。
项目地址:https://gitee.com/durcframework/torna
Apifox
一款在线使用的API文档管理工具,可以配合Swagger使用,功能强大,界面炫酷!
Apifox 的定位是Postman + Swagger + Mock + JMeter
,具有API文档管理、API调试、API Mock、API 自动化测试等功能。可以通过一种工具解决之前使用多种工具的数据同步问题。高效、及时、准确!
官方网站:https://www.apifox.cn/
总结
本文整理了之前使用过的7种API文档生成+管理工具,如果你是刚开始使用API文档工具的话,使用Swagger准没错!如果你正在使用Swagger,想要使用更好的API文档工具的话,可以考虑将Swagger配合Knife4j、YApi或Torna来使用。如果你不介意在线使用API文档管理工具的话,可以使用Apifox,它的功能更强大。
我是小富~,如果对你有用在看、关注支持下,咱们下期见~