这些年来我用过很多API文档工具，也写过很多相关的文章。发现API文档工具哪个更好用一直是大家关心的话题。今天整理了我用过的7款API文档工具，每一款都有详细的教程，一定有你喜欢的！SpringBoot实战电商项目商城（50k+star）地址：https://github.com/macrozheng/mallSwaggerSwagger是一款非常流行的API文档工具，可以帮助你简化API文档的开发，大大提高开发效率。之前在mall项目中用过。我们一般结合使用Swagger和SpringBoot，使用Springfox提供的工具。使用该工具可以根据注解自动生成API文档，并对生成的文档进行接口调试。由于API文档随着项目的启动而更新，保证了API文档的实时性！Springfox官方也为我们提供了Starter，集成起来非常方便。如果你还在SpringBoot项目中手动集成Swagger，不妨看看《还在手动整合Swagger？Swagger官方Starter是真的香！》。项目地址：https://github.com/springfox/...虽然Swagger非常好用，但是Knife4j的缺点是界面不美观，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除了增强Swagger的Knife4j等工具外，还有一类工具具有API文档管理的功能，可以独立部署并接入Swagger，具有更强大的功能。也可以称为API文档管理平台。YApi就是这样一个工具。YApi是一个高效、易用、强大的API管理平台，旨在为开发者、产品、测试人员提供更优雅的接口管理服务。YApi在Github上积累了18K+Star，交互体验极佳。YApi不仅提供了常用的接口管理功能，还提供了权限管理、Mock数据、Swagger数据导入等功能。总之，功能很强大！YApi的具体使用请参考《当Swagger遇上YApi，瞬间高大上了！》。项目地址：https://github.com/YMFE/yapismart-docSwagger需要通过自身的注解生成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是一款可以与Swagger搭配使用的在线API文档管理工具，功能强大，界面炫酷！Apifox的定位是Postman+Swagger+Mock+JMeter，具有API文档管理、API调试、APIMock、API自动化测试等功能。以前使用多个工具的数据同步问题，一个工具就可以解决。高效、及时、准确！具体用法请参考：《取代 Postman + Swagger！这款神器功能更强大，界面更炫酷！》。官网：https://www.apifox.cn/总结本文整理了之前用过的7个API文档生成+管理工具。如果你是刚开始使用API??文档工具，那你一定要用Swagger！如果您正在使用Swagger并希望使用更好的API文档工具，您可以考虑将Swagger与Knife4j、YApi或Torna结合使用。如果不介意在线使用一个API文档管理工具，可以使用功能更强大的Apifox。本文GitHubhttps://github.com/macrozheng/mall-learning已收录，欢迎Star！
