·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-11

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