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

发布于

cvooc:

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

想找一个比较方便的维护 API 文档的方式，让 AI 与我沟通时能够自行查询相关接口的参数返回。
想看一下各位是如何管理文档的。

---

原文链接：[点击查看](https://www.v2ex.com/t/1228853)

评论（3）

回复 dethan 和 AreYou0k：
拉源码在多人多模块的项目里太麻烦了，几十个 Git 仓库全拉一遍不现实。而且有个文档做中间层，让 AI 自己 `git diff` 一下就能看出接口变更，这点很关键。
生成 JSON 逻辑也通，但归根结底还是人工维护文件让 AI 读，不够优雅。选 Markdown 主要是方便开发自己看，JSON 行数太多眼晕。想求个更好用的知识库工具方案！

· 0 个赞

能拉后端源码就直接拉源码呗，现在的 AI 上下文够长，完全吃得下

· 0 个赞

都 AI 时代了还要啥文档啊，直接生成个 JSON 扔给 AI 读不就行了

· 0 个赞