API 与接口设计

原名：api-and-interface-design

帮助设计稳定、清楚、可演进的 REST、GraphQL 或模块接口。

中文 Skills 技能说明

用于定义或调整公开接口和模块边界。重点包括资源命名、请求响应结构、错误语义、兼容策略、幂等性和版本演进，避免让调用方依赖不稳定的内部实现。

上游能力依据

上游原始适用说明：Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.

上游 SKILL.md 主要章节（保留原文标题）：

Overview
When to Use
Core Principles
Hyrum's Law
The One-Version Rule
1. Contract First
2. Consistent Error Semantics
3. Validate at Boundaries
4. Prefer Addition Over Modification
5. Predictable Naming

使用边界

先读取项目约定、依赖版本和现有测试，再提出最小改动。写文件、运行脚本、提交代码或发布前应检查差异并保留回退路径。

作者、翻译与许可证

原作者: Addy Osmani
中文翻译: CEOFans翻译
许可证: MIT
上游来源: https://github.com/addyosmani/agent-skills/tree/f49337711b7a932b4b338c1d4ad73384df8fd87d/skills/api-and-interface-design

适用范围

平台：linux、macos、windows；标签：API、Interface Design、Architecture

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件，请在最小权限环境中使用，高风险操作必须人工确认。

如发现侵权、许可证或安全问题，可在本页前台提交投诉，管理员复核后可立即下架。