api-and-interface-design:先把邊界和契約說清楚
以契約先行方式設計 API、模組邊界與公開介面,包含錯誤語意、相容性與驗證責任。
學完會知道
- 理解 api-and-interface-design 在開發流程裡負責的工作
- 判斷什麼情況適合使用 api-and-interface-design
- 完成通用 Skills CLI、Codex 或 Claude Code 安裝
開始前先準備
- 可使用支援 Agent Skills 的 coding agent
- 準備一個能實際驗證的小型開發任務
這個 Skill 在做什麼
以契約先行方式設計 API、模組邊界與公開介面,包含錯誤語意、相容性與驗證責任。
為什麼有用
公開介面一旦有人使用,就不再只是內部實作細節。這個 Skill 先定義呼叫者能依賴的契約,再處理版本、錯誤與邊界驗證,減少日後被隱性依賴綁住。
適合什麼場景
- 新增前後端之間的 API。
- 拆分模組或替兩個團隊定義資料契約。
- 修改既有公開介面,必須評估相容性。
和站內相近內容的差別
Matt Pocock 的除錯與維護流程 介紹 codebase-design 的 module、interface、depth 與 seam。api-and-interface-design 更聚焦公開契約、錯誤語意和版本相容性。
如何安裝
想先查看可選清單,可以執行:
npx skills add addyosmani/agent-skills --list
只安裝這一個 Skill:
npx skills add addyosmani/agent-skills --skill api-and-interface-design
安裝完整 24 個 Skills:
npx skills add addyosmani/agent-skills
這個 Skill 的 SKILL.md 沒有引用上游根目錄的共用 references。只想使用這一個流程時,可以單獨安裝;若會串接其他開發階段,再裝整套會比較省事。
手動安裝時,先 clone 上游 repo,再把整個 Skill 資料夾放進代理使用的 skills 目錄:
git clone https://github.com/addyosmani/agent-skills.git
來源資料夾是 skills/api-and-interface-design/。如果上面列出共用 references,還要保留上游的相對路徑。
Codex
Codex CLI 0.122 以上可安裝整套原生外掛:
codex plugin marketplace add addyosmani/agent-skills
codex plugin add agent-skills@agent-skills
安裝後重新開啟 session。手動指定時輸入 @api-and-interface-design;也可以直接描述任務,讓 Codex 依 Skill 的 description 自動選用。
Claude Code
Claude Code 可從 marketplace 安裝:
/plugin marketplace add addyosmani/agent-skills
/plugin install agent-skills@addy-agent-skills
此外掛也提供 /spec、/plan、/build、/test、/review、/code-simplify 與 /ship 等流程指令。這些指令會編排對應 Skills,不代表每個指令都只使用本頁這一個 Skill。
自動啟用還是手動指定
自動優先。偵測到 API 或公開邊界時就應套用。重大版本變更仍應手動指定,讓相容性決定得到明確審查。
在 Codex 手動呼叫的寫法:
@api-and-interface-design
請依這個 Skill 的原始流程處理目前任務,完成後列出驗證證據。
原始來源
相關 Skill
讀完後可以直接點進去複製來試的本地 Skill。