Skill 广场
API与接口规范设计 Skill

API与接口规范设计.Skill

@addyosmani/api-and-interface-design

4.8优秀AI 评分基础检查通过源自 GitHub

该能力专为后端开发、架构师及全栈工程师打造,用于指导和规范各类公共接口与模块边界设计。它基于 Hyrum 定律、单版本原则及契约优先理念,帮助用户构建稳定、具备向后兼容性、统一错误语义及可靠幂等机制的 RESTful 接口、GraphQL 模式或 TypeScript 类型契约。通过规避端点结构不一致、隐式破坏性变更与重试并发冲突等典型问题,显著降低系统集成风险与协作维护成本。

编程后端开发工程师前端与全栈开发工程师系统架构师2026-09-23 更新main

API与接口规范设计

该能力专为后端开发、架构师及全栈工程师打造,用于指导和规范各类公共接口与模块边界设计。它基于 Hyrum 定律、单版本原则及契约优先理念,帮助用户构建稳定、具备向后兼容性、统一错误语义及可靠幂等机制的 RESTful 接口、GraphQL 模式或 TypeScript 类型契约。通过规避端点结构不一致、隐式破坏性变更与重试并发冲突等典型问题,显著降低系统集成风险与协作维护成本。

它会先理解你的原始内容和目标,再按清晰的步骤完成处理。你不需要学习复杂命令,也不用理解背后的技术细节。

常见场景

它能帮你做什么?

01

02

03

三步完成

怎么使用

1安装 Skill

把右侧安装请求发给你的 AI。

2说清楚目标

告诉 AI 你想完成什么,或直接贴入内容。

3检查结果

按需要继续调整语气、范围或格式。

复制就能用

你可以直接这样说

请为我们的任务看板服务设计一套标准的 RESTful 接口契约,包含任务 CRUD、分页、标签过滤以及统一的错误响应格式(采用 TypeScript 类型表示)。

我们需要实现一个支付扣款接口,请根据幂等性最佳实践,设计请求头规范、原子化防重逻辑、不同请求体检测方案及异常重试状态码(409/202)。

请帮我审查现有的用户信息更新接口,指出潜在的破坏性变更隐患,并将其重构为符合边界验证(Zod/TypeScript)与可辨识联合类型的稳健接口。

适用人群

适合谁?

后端开发工程师前端与全栈开发工程师系统架构师技术团队负责人

上手门槛

使用难度

进阶

需要了解任务流程,页面已整理好使用步骤。

兼容范围

支持哪些 AI?

Codex可直接使用
Claude Code可直接使用
OpenClaw可直接使用
Hermes可直接使用
国内 Agent可直接使用

中文用户增强

Skill Px 做了什么?

中文说明简化使用方式补充中文案例整理安装流程降低理解难度