[Vibe Coding] 多人协作项目,大家在 vibe 时都是如何给 ai 提供 api 文档的?有什么高级点的方法推荐吗? 有类似的知识库推荐吗?

[cvooc]

我目前的方案是手动维护一个 swagger 导出的 md 文档,然后让 ai 去读取 md. 因为是多人多模块开发, 直接拉后端源码去读也不是一个便捷的方式.

想找一个比较方便的维护 api 文档的方式, 和 ai 沟通时直接让 ai 自行查询相关接口的参数返回. 想看一下各位是如何管理文档的.

[dethan]

能拉源码就拉源码呗，现在的 ai 吃得下

[AreYou0k]

直接生成一个 json 文件, 都 ai 时代了还要啥文档啊

[cvooc]

@dethan 拉源码的问题在于, 多人项目, 前端有多人后端有多人,几十个模块 git 仓库, 那得每个人电脑都把所有项目拉一遍,有时候可能只是接口改了个参数. 再一个是我体验下来, 拉源码不好体现出接口变更, 中间有个文档转的话,让 ai 自己 git diff 文档变化直接就出来了.

@AreYou0k 是这个理,json 也行, 但是思路跟我现在一样, 就是人维护个文件让 ai 读取. 我选 md 主要是方便人同时查看, 导出的 json 行数更多看起来不方便. 但是操作流程给我没变. 就是感觉不够优雅, 想着有类似的知识库工具没有, 用起来更方便些.

[dethan]

swagger 有在线 doc.html,给 AI 这个地址也行吧

[ydong]

用 apifox 管理接口文档就行了，官方自带了 mcp 和 skill 很方便，我们目前就是这么干的