做开发的都知道,写API文档是个费劲活。不写还不行,交接、对接、维护都得靠它。但手动写不仅慢,还容易出错,改个接口字段就得翻半天文档。我之前在小公司干过,人少事多,根本没时间精雕细琢文档,直到用了几个趁手的工具,才真正从文档里解放出来。
Swagger(OpenAPI):老牌但靠谱
Swagger 算是API文档界的元老了,现在叫 OpenAPI。它最大的好处是支持代码注解自动生成文档。比如你在 Spring Boot 项目里加个 @ApiOperation 注解,启动后直接就能看到网页版的接口说明。
集成也简单,Maven 加个依赖:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.14</version>
</dependency>
然后启动项目,访问 /swagger-ui.html 就能看到自动生成的页面。支持在线测试,前端同事直接点着调,省了来回问的时间。
Postman + 文档发布:适合小团队
如果你已经在用 Postman 写接口测试,那顺手生成文档简直白送。你只要把请求整理成集合,点一下“Publish”,就能生成一个带样例、参数、返回值的网页文档。
最实用的是,你可以设成免费公开链接,发给合作方或外包团队,他们自己看就行,不用再邮件来回传PDF。我们之前接了个外包项目,对方就甩了个 Postman 文档链接过来,打开就能试,体验直接拉满。
Apifox:国产全能王
要说近几年冒出来的黑马,Apifox 必须提一嘴。它把 Swagger 的生成能力、Postman 的调试、Mock 数据、团队协作全打包在一起,关键是国内访问快,界面也清爽。
你可以在里面设计接口,然后一键导出标准文档,还能嵌入公司内网。我们团队去年换上 Apifox 后,前后端联调时间少了快一半。以前前端等接口定义,现在直接看文档Mock数据,边写边测。
Docute:零配置静态文档
有些项目不需要复杂功能,就想放个简洁的说明页。这时候 Docute 就很合适。它基于 Markdown,扔到 GitHub Pages 上就能跑,完全免费。
比如你有个开源小工具,想让人快速上手,写个 README.md,加几行配置,几分钟就搭好一个响应式文档站。我之前分享一个爬虫脚本,就用 Docute 搞了个页面,朋友说比直接看GitHub清爽多了。
这些工具都不贵,甚至大部分免费。关键是把人从重复劳动里捞出来,把时间花在更值的事上。省下的时间,喝杯咖啡不香吗?