API 与接口设计

addyosmani/agent-skills

设计稳定的 API 契约,明确输入类型、统一错误、分页及重试语义。

最近更新于:

查看 GitHub 项目
npx skills add addyosmani/agent-skills --skill api-and-interface-design
116,280Stars12,180Forks仓库最近推送

关于这个 Skill

设计稳定的 API 契约,明确输入类型、统一错误、分页及重试语义。先确认调用方和数据契约,再检查增量变更、分页与原子幂等处理。

为什么推荐

Addy Agent Skills 中的任务工作流。遵循上游指令并保留引用的共用文件;实际可执行步骤取决于宿主能力和项目配置。

适合用来做什么

  • 新接口或模块边界需要先明确契约。

方法与交付

先确认调用方和数据契约,再检查增量变更、分页与原子幂等处理。

请求与响应类型、边界校验、统一错误,以及兼容性与幂等性决策。

API 与接口设计指令

保留所需参考资料

需要共用参考资料时,采用上游说明的完整仓库接入方式。skills CLI 的单项安装只复制 skills/<name>/,可能缺少仓库级 references/ 检查清单;应保留工作流所需的共用文件。

上游说明与接入方式

使用前需要了解

  • 需要能加载 Skill Markdown 并访问项目的 Agent;文件编辑、命令、构建与检查依具体工作流和环境而定。
  • 使用项目自身的运行环境、依赖与验证命令;Skill 文件提供操作指引,不会替项目安装工具。
  • 需要共用参考资料时,采用上游说明的完整仓库接入方式。skills CLI 的单项安装只复制 skills/<name>/,可能缺少仓库级 references/ 检查清单;应保留工作流所需的共用文件。

支持的 Agent

Claude CodeCodex CLICursorGitHub CopilotGemini CLIOpenCodeKiroGoogle Antigravity

资料与来源

原始资料见下方链接;文中的上手建议由 SkillHey 编辑整理。