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