共计 2612 个字符，预计需要花费 7 分钟才能阅读完成。
这些年用过不少 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！
