关于 w-api-docs
w-api-docs 是用于维护 API 文档的开发技能，强调修改所属的架构定义或路由，而非直接编辑生成文件。它指导维护者查找生成器、重新生成产物，并在行为变化时更新使用方文档。
主要功能
- 01查找事实来源和生成器
- 02修改架构定义或路由，而非生成文件
- 03运行生成并检查漂移
- 04行为变化时更新使用方文档
适用场景
- 01路由变更后修订 API 文档
- 02从源代码重新生成 OpenAPI 产物
- 03检查生成结果是否与仓库不一致
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/w-api-docs确认已加载。
详细介绍
从事实来源更新 API 文档（TypeBox/Fastify 路由，或仓库中记录的生成器）。切勿直接编辑生成的 OpenAPI、生成的客户端或生成的 SQL。
- 阅读 API 文档 MDX 和生成器 README。找出源文件，以及
package.json中的生成脚本。 - 修改所属的架构或路由，而不是生成的产物。
- 运行文档中记录的生成命令。如果仓库中有漂移检查脚本，也要运行。
- 仅在行为发生变化时更新使用方 MDX。不要臆造身份验证、速率限制或版本管理策略。
- 文档：如果行为或命令发生变化，使用
/w-docs。
评论
支持 Markdown