后端与接口
API 文档由 schema/路由生成时:从源头重新生成并同…
当 API 文档需要根据 TypeBox/Fastify 路由或仓库内生成器更新时,按源头修改并重新生成文档。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 38/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 55/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 60/100 ×0.15
适用场景
API 文档由 schema/路由生成时特定
解决思路
- 从真相源更新 API 文档:优先改 TypeBox/Fastify 路由,或使用仓库文档中说明的生成器;不要直接编辑生成的 OpenAPI、生成的客户端或生成的 SQL。
- 阅读 API 文档 MDX 和生成器 README,确认拥有该契约的源头,以及 package.json 中对应的生成脚本。
- 修改拥有契约的 schema 或 route,而不是修改生成后的产物。
- 运行文档中指定的生成命令;如果仓库有 drift 检查脚本,也运行它们检查漂移。
- 仅在行为发生变化时更新面向接入方的 MDX;不要自行编造认证、限流或版本化策略。
- 如果行为或命令发生变化,按文档流程运行 `/w-docs`。
适用边界 · 注意事项
- 当仓库没有可识别的源头 schema/route 或文档化生成器时,不适用;应先找到真理源。
- 当只是修改非 API 契约的普通说明文档、排版或文案,不涉及生成产物时,不必使用该流程。
- 不要把它当成手工编辑生成 OpenAPI/client/SQL 的许可;这些文件仍应通过生成命令更新。