这些年来，使用了很多API文档工具，也写了很多相关的文章。我发现用哪些API文档工具比较好一直是大家关心的话题。今天整理了7个我用过的API文档工具，每一个都有详细的教程。一定有你喜欢的！ 　　

　　

　　SwaggerSwagger是一款非常流行的API文档工具，可以帮助你简化API文档的开发，大大提高开发效率。之前在商城项目中用过。 　　

　　

　　 　　

　　

　　一般我们结合SpringBoot使用Swagger，使用Springfox提供的工具。利用该工具可以根据注释自动生成API文档，并对生成的文档进行接口调试。 　　

　　

　　由于API文档是随着项目的启动而更新的，所以API文档的实时性是有保证的！Springfox官方还为我们提供了Starter，集成起来非常方便。如果你还在SpringBoot项目中手动集成Swagger，不妨看看《还在手动整合Swagger？Swagger官方Starter是真的香！》。 　　

　　

　　项目地址：https://github.com/springfox/springfox 　　

　　

　　Knife4j非常好用，但是有一些缺点，比如界面不够美观，API调试功能较弱。比如请求参数不检查，返回一堆JSON数据的时候不能折叠。所以在Swagger的基础上，还有一些增强工具。 　　

　　

　　Knife4j是springfox-Swagger的增强UI实现，为Java开发者在使用Swagger时提供了简洁而强大的界面文档体验。Knife4j完全沿用了springfox-Swagger中的用法，并在此基础上进行了增强。如果你用过swagger，可以无缝切换到Knife4j。 　　

　　

　　 　　

　　

　　用Knife4j就像给Swagger换了新皮肤，瞬间让他变高了。具体使用请参考《给Swagger换了个新皮肤，瞬间高大上了！》。 　　

　　

　　如果你的项目是微服务项目，可以使用Knife4j聚合所有服务的文档。具体使用请参考《微服务聚合Swagger文档，这波操作是真的香！》。 　　

　　

　　 　　

　　

　　项目地址：https://github.com/xiaoymin/swagger-bootstrap-ui 　　

　　

　　Postman由于Swagger的接口调试能力较弱，使用Postman进行调试也是一个不错的解决方案。 　　

　　

　　Postman是一个API接口调试工具，可以方便的用来测试接口，后端人员可以导出自己的调试结果，方便前端人员调试。具体使用请参考《Postman：API接口调试利器》。 　　

　　

　　 　　

　　

　　当然也可以在Postman中查看API文档，但是功能有点弱，于是就有了现在流行的Swagger Postman组合。详情请咨询《Swagger界面丑、功能弱怎么破？用Postman增强下就给力了！》。 　　

　　

　　 　　

　　

　　官方网站：https://www.postman.com/ 　　

　　

　　除了Knife4j等增强Swagger的工具，YApi还有Api文档管理的功能，可以独立部署，与Swagger对接。功能更强大，也可以叫API文档管理平台。 　　

　　

　　雅皮就是这样一个工具。YApi是一个高效、易用、功能强大的Api管理平台，旨在为开发者、产品和测试人员提供更优雅的界面管理服务。雅皮在Github上积累了18K星，交互体验极佳。YApi不仅提供了常用的接口管理功能，还提供了权限管理、模拟数据、Swagger数据导入等功能。总之很厉害！ 　　

　　

　　 　　

　　

　　雅皮具体使用请参考《当Swagger遇上YApi，瞬间高大上了！》。 　　

　　

　　项目地址：https://github.com/YMFE/yapi 　　

　　

　　Smart-docSwagger需要自己的注释来实现API文档的生成，代码侵入性如下 　　

点强，如果你想零入侵的话，不妨试试smart-doc。

　　

smart-doc是一款API文档生成工具，无需多余操作，只要你规范地写好代码注释，就能生成API文档。同时能直接生成Postman调试文件，一键导入Postman即可调试，非常好用！

　　

　　

smart-doc和Swagger的接口调试能力一样，都比较弱，也得配合Postman来使用，具体可以参考《还在用Swagger？试试这款零注解侵入的API文档生成工具，跟Postman绝配！》 。

　　

项目地址：https://gitee.com/smart-doc-team/smart-doc

　　

Torna又一款可独立部署的API文档管理工具，可以搭建API文档管理平台。不仅支持Swagger导入、还支持Postman和OpenApi等导入。

　　

　　

Torna是一套企业级接口文档解决方案，可以配合Swagger使用，具体参考《当 Swagger 遇上 Torna，瞬间高大上了！》 。它具有如下功能：

　　

文档管理：支持接口文档增删改查、接口调试、字典管理及导入导出功能；权限管理：支持接口文档的权限管理，同时有访客、开发者、管理员三种角色；双模式：独创的双模式，管理模式可以用来编辑文档内容，浏览模式纯粹查阅文档，界面无其它元素干扰。

　　

项目地址：https://gitee.com/durcframework/torna

　　

Apifox一款在线使用的API文档管理工具，可以配合Swagger使用，功能强大，界面炫酷！

　　

Apifox 的定位是Postman + Swagger + Mock + JMeter，具有API文档管理、API调试、API Mock、API 自动化测试等功能。可以通过一种工具解决之前使用多种工具的数据同步问题。高效、及时、准确！

　　

　　

具体使用可以参考：《取代 Postman + Swagger！这款神器功能更强大，界面更炫酷！》 。

　　

官方网站：https://www.apifox.cn/

　　

总结本文整理了之前使用过的7种API文档生成+管理工具，如果你是刚开始使用API文档工具的话，使用Swagger准没错！如果你正在使用Swagger，想要使用更好的API文档工具的话，可以考虑将Swagger配合Knife4j、YApi或Torna来使用。如果你不介意在线使用API文档管理工具的话，可以使用Apifox，它的功能更强大。