w-api-docs

用途

w-api-docs 用于从拥有 schema 的源头刷新 API 文档。它的核心原则是：永远不要手工编辑生成的 OpenAPI、生成的客户端或生成的 SQL，而应修改拥有 schema 或路由的源头，再通过文档化的生成命令重新生成产物。

主要能力

• 从源头更新 API 文档，而非直接编辑生成产物。
• 支持 TypeBox/Fastify 路由，或仓库中已记录的生成器。
• 识别拥有源与 package.json 中的生成脚本。
• 运行文档化的生成命令。
• 在仓库提供漂移脚本时检查漂移。
• 仅针对行为变化更新采用者 MDX。

使用方式

1. 阅读 API 文档 MDX 与生成器 README。
2. 识别拥有源与 package.json 中的生成脚本。
3. 修改拥有 schema 或路由，而不是生成产物。
4. 运行文档化的生成命令。
5. 如果仓库有漂移脚本，检查漂移。
6. 仅针对行为变化更新采用者 MDX。
7. 不要臆造认证、限流或版本策略。
8. 如果行为或命令发生变化，参考 /w-docs。

适用场景

适用于使用 TypeBox/Fastify 路由或仓库中已有文档生成器的项目，需要从源头刷新 API 文档时。

限制

• 不得手工编辑生成的 OpenAPI、生成的客户端或生成的 SQL。
• 不得臆造认证、限流或版本策略。
• 仅针对行为变化更新采用者 MDX。
• 关于收费、价格、平台、效果等具体信息暂未提供。