一、基本信息
| 项目 | 内容 | 数据来源 |
|---|---|---|
| 正式名称 | api-and-interface-design-addyosmani-agent-skills | 合集子目录名 + 拥有者 + 仓库名 |
| 作者/维护者 | Addy Osmani(独立开发者) | GitHub API |
| 来源链接 | https://github.com/addyosmani/agent-skills/tree/main/skills/api-and-interface-design | — |
| 许可证 | MIT(仓库级) | GitHub API |
| 所属合集 | agent-skills(25 个子技能的工程实践合集),子技能各自独立可安装 | GitHub API + README |
| 最新版本 | 仓库最新 Release 0.6.9(2026-09-05);本子技能最近改动 2026-08-13 | GitHub API |
| 安装方式 | 见第十章 | 官方 README |
二、功能介绍与亮点
一份“如何设计不易被误用的稳定接口”的工程实践指南,覆盖 REST API、GraphQL Schema、模块边界与组件 props:
- Hyrum 定律:用户足够多时,API 一切可观察行为都会被依赖,设计须刻意收敛暴露面
- 契约先行 + 统一错误语义:先定接口契约再实现,避免异常/null/
{error}混用 - 边界校验:外部输入与第三方响应须校验,且第三方响应可能带指令式文本,属不可信数据
- 幂等键护栏(最扎实一节):如何正确派生幂等键、用唯一约束做原子声明取代“先查后写”竞态、并发重复请求的三种应对策略
全文为纯 Markdown 指南,无可执行脚本,安装即用。
三、适用场景
所属分类:工程效率与代码质量
适合设计 REST/GraphQL 端点、划定模块边界、定义前后端类型契约、或需处理支付类接口幂等重试逻辑的工程师,可直接当设计检查清单用。核心产出是通用工程方法,不绑定具体平台,故归入工程效率与代码质量。
四、跨 Agent 兼容性
- Claude Code:原生支持 ✅——
/plugin marketplace add+/plugin install - Codex:原生支持 ✅——
codex plugin marketplace add,通过.codex-plugin/plugin.json直接读取 - OpenClaw / Hermes Agent:未验证 ❓——未见官方文档中的专门适配说明
五、推荐理由
把 API 设计中最易出错、也最难事后补救的问题(隐性契约、错误语义不统一、幂等键形同虚设)系统化成可套用的清单;幂等键一节把“接受了 header”和“正确处理它”之间的差距讲得很具体,能帮工程师在设计阶段就避免上线后才暴露的重复扣款、竞态问题。
六、评分
| 维度 | 分数 | 说明 |
|---|---|---|
| 受欢迎程度 | 8 | 作者 Addy Osmani 为知名独立开发者;仓库整体 94,747 stars 属整个合集不代表本技能自身热度;该子技能暂无独立第三方讨论,API 设计是被广泛认可的主流工程方法论 |
| 可用性 | 9 | 纯 Markdown 指南,无依赖、无需 API Key,一条命令即用,示例丰富,仓库近期活跃维护 |
| 安全性 | 10 | 无 shell 执行、无网络外发、无凭据要求,通读全文未见可疑指令 |
综合评分:9.0
安全检查清单:①无 shell 执行 ②无网络外联 ③无需凭据 ④未见可疑指令 ⑤作者信誉良好 ⑥License 明确(MIT)⑦持续活跃维护
七、跟同类 Skills 相比的优势
| 技能 | 定位 | 与本技能的差异 |
|---|---|---|
| code-review-and-quality(同合集) | 五轴代码审查清单 | 审查已写好的代码,不覆盖接口设计阶段的决策 |
| Agent-Skills-for-Context-Engineering 的工具契约模块 | 多智能体工具调用契约 | 只覆盖“Agent 调用工具”场景,不含 REST/GraphQL 与幂等键细节 |
| 各类平台专属 API 集成技能(Stripe、Zapier 等) | 教如何调用某个第三方 API | 是“如何用别人的 API”,本技能是“如何设计自己的 API” |
八、用户评价
该技能目前在第三方平台尚无具名用户评价。
九、安装使用方式
Claude Code:
/plugin marketplace add addyosmani/agent-skills
/plugin install agent-skills@addy-agent-skills
通用 skills CLI(覆盖 Codex / Cursor 等多种智能体):
npx skills add addyosmani/agent-skills --skill api-and-interface-design
安装后无需重启,agent 检测到“设计 API/接口/模块边界”类任务会自动触发。
十、注意事项
- 仅安装单个子技能时,仓库级
references/共享目录不会一并复制(官方 Issue #361 已跟踪) - 技能是方法论指南,不含执行代码,落地仍需工程师自己实现
- OpenClaw、Hermes Agent 兼容性未获官方文档确认,跨平台使用前建议先手动验证