这些年用过不少API文档工具，也写过不少相干的文章，我发现哪种API文档工具更好用始终都是大家比较关心的话题。明天整顿了下我已经用过的7种API文档工具，每个都有具体的应用教程，必定有你中意的一种！

SpringBoot实战电商我的项目mall（50k+star）地址：https://github.com/macrozheng/mall

Swagger

Swagger是一款十分风行的API文档工具，它能帮忙你简化API文档的开发，极大进步开发效率，之前在mall我的项目中就是应用的它。

咱们个别将Swagger和SpringBoot联合应用，应用的是Springfox给咱们提供的工具。应用该工具能够依据注解主动生成API文档，并且能够在生成的文档上进行接口调试。

因为API文档随着我的项目的启动而更新，所以API文档的实时性很有保障！Springfox官网还给咱们提供了Starter，整合十分不便，如果你还在SpringBoot我的项目中手动整合Swagger的话，无妨看下《还在手动整合Swagger？Swagger官网Starter是真的香！》 。

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

Knife4j

尽管Swagger曾经十分好用，然而存在界面不够好看，API调试性能弱的毛病，比方申请参数没有校验，返回一堆JSON数据时无奈折叠这类问题。于是在Swagger的根底上，就有了一些加强工具的呈现。

Knife4j是springfox-swagger的加强UI实现，为Java开发者在应用Swagger的时候，提供了简洁、弱小的接口文档体验。Knife4j齐全遵循了springfox-swagger中的应用形式，并在此基础上做了加强性能，如果你用过Swagger，你就能够无缝切换到Knife4j。

应用Knife4j就如同给Swagger换了个新皮肤，霎时就高大上了，具体应用能够参考《给Swagger换了个新皮肤，霎时高大上了！》 。

如果你的我的项目是微服务项目的话，应用Knife4j能够聚合所有服务的文档，具体应用能够参考《微服务聚合Swagger文档，这波操作是真的香！》 。

我的项目地址：https://github.com/xiaoymin/s...

Postman

因为Swagger的接口调试能力比拟弱，应用Postman来调试也不失为一个好计划。

Postman是一款API接口调试工具，应用它能够很不便的对接口进行测试，并且后端人员能够将本人的调试后果导出，不便前端人员调试，具体应用能够参考《Postman：API接口调试利器》 。

当然在Postman中查看API文档也是能够的，只是性能有点偏弱，所以才有了Swagger+Postman这种风行组合，具体能够参考《Swagger界面丑、性能弱怎么破？用Postman加强下就给力了！》 。

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

YApi

除了Knife4j这类给Swagger做加强的工具，还有一类工具自身就具备API文档治理的性能，可独立部署并且能够对接Swagger，性能更加弱小，也能够称之为API文档治理平台。

YApi正是这样一种工具，YApi是高效、易用、功能强大的API治理平台，旨在为开发、产品、测试人员提供更优雅的接口治理服务。YApi在Github上已累计取得了18K+Star，具备优良的交互体验，YApi不仅提供了罕用的接口治理性能，还提供了权限治理、Mock数据、Swagger数据导入等性能，总之性能很弱小！

YApi的具体应用能够参考《当Swagger遇上YApi，霎时高大上了！》 。

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

smart-doc

Swagger须要通过它本人的注解来实现API文档的生成，代码入侵性有点强，如果你想零入侵的话，无妨试试smart-doc。

smart-doc是一款API文档生成工具，无需多余操作，只有你标准地写好代码正文，就能生成API文档。同时能间接生成Postman调试文件，一键导入Postman即可调试，十分好用！

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

我的项目地址：https://gitee.com/smart-doc-t...

Torna

又一款可独立部署的API文档管理工具，能够搭建API文档治理平台。不仅反对Swagger导入、还反对Postman和OpenApi等导入。

Torna是一套企业级接口文档解决方案，能够配合Swagger应用，具体参考《当 Swagger 遇上 Torna，霎时高大上了！》 。它具备如下性能：

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

我的项目地址：https://gitee.com/durcframewo...

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，它的性能更弱小。

本文 GitHub https://github.com/macrozheng/mall-learning 曾经收录，欢送大家Star！