·api-documentation
""

api-documentation

当 API 代码更改(路由、端点、模式)时使用。强制 Swagger/OpenAPI 同步。如果文档发生偏差,则暂停工作,从而触发文档审核技能。

4安装·0热度·@troykelly

安装

$npx skills add https://github.com/troykelly/codex-skills --skill api-documentation

如何安装 api-documentation

通过命令行快速安装 api-documentation AI 技能到你的开发环境

  1. 打开终端: 打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等)
  2. 运行安装命令: 复制并运行以下命令:npx skills add https://github.com/troykelly/codex-skills --skill api-documentation
  3. 验证安装: 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code、Cursor 或 OpenClaw 中使用

来源:troykelly/codex-skills。

SKILL.md

查看原文

Ensures all API changes are reflected in Swagger/OpenAPI documentation. When documentation drift is detected, work pauses until documentation is synchronized.

Core principle: API documentation is a first-class artifact, not an afterthought. No API change ships without documentation.

Announce at start: "I'm using api-documentation to verify Swagger/OpenAPI sync."

当 API 代码更改(路由、端点、模式)时使用。强制 Swagger/OpenAPI 同步。如果文档发生偏差,则暂停工作,从而触发文档审核技能。 来源:troykelly/codex-skills。

可引用信息

为搜索与 AI 引用准备的稳定字段与命令。

安装命令
npx skills add https://github.com/troykelly/codex-skills --skill api-documentation
分类
""沟通写作
认证
收录时间
2026-02-25
更新时间
2026-03-10

Browse more skills from troykelly/codex-skills

快速解答

什么是 api-documentation?

当 API 代码更改(路由、端点、模式)时使用。强制 Swagger/OpenAPI 同步。如果文档发生偏差,则暂停工作,从而触发文档审核技能。 来源:troykelly/codex-skills。

如何安装 api-documentation?

打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/troykelly/codex-skills --skill api-documentation 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code、Cursor 或 OpenClaw 中使用

这个 Skill 的源码在哪?

https://github.com/troykelly/codex-skills