项目做到一半,突然发现接口文档找不到了,心里一紧,进度卡住,干着急也没用。这种情况很多人都遇到过,尤其是团队协作时,文档没存好、链接失效、人走了文档也跟着没了。其实别慌,有几个实在办法能帮你快速找回或替代方案。
先去常用平台翻一翻
很多公司用的都是固定的文档工具,比如语雀、Confluence、飞书文档、钉钉文档或者企业微信。直接打开这些平台,搜关键词,比如项目名+“接口”或者负责人名字,说不定就藏在某个角落里。有时候文档权限没开,联系一下管理员加个权限就行。
翻代码仓库里的 README 或注释
有些开发者懒得单独写文档,就把接口信息直接写在代码里。去 Git 仓库看看项目的 README.md 文件,或者打开 controller 层、API 路由文件,里面经常会有详细的注释。比如:
// GET /api/user/info
// 响应:{"id": 1, "name": "张三", "status": 1}
这种虽然不是正式文档,但足够你临时对接了。
用抓包工具看真实请求
如果前端页面还能访问,直接打开浏览器开发者工具,切到 Network 标签页,刷一下页面,所有接口请求都会出来。点进去看 Headers 和 Response,URL、参数、返回结构全都有。这是最真实的“活文档”,比写的还准。
问问老同事或者前任负责人
有时候文档不在系统里,在人的脑子里。找个熟悉项目的同事问问,或者在群里发句话:“谁有XX模块的接口文档?” 很多人只是忘了分享,一提醒就发出来了。要是前任开发还在公司,哪怕调岗了,打个招呼也能拿到资料。
自己动手补一份
如果真的一点痕迹都没有,那就边对接边整理。用 Postman 或 Apifox 把每个接口记下来,加好备注。以后别人再问你,你就是那个“文档最全”的人。而且下次类似问题,你自己也能省不少时间。
接口文档丢了不可怕,关键是别卡住。多留几个心眼,平时看到重要文档顺手收藏一下,省得临时抱佛脚。