接口契约与错误响应设计

原名：api-designer

整理资源、分页、版本和错误结构，给客户端提供可核对的请求响应示例。

中文 Skills 技能说明

OPC 要让桌面端与线上系统协作时，可让开发岗位员工与 API测试工程师先定契约。提供业务规则、角色权限、旧接口和调用示例，技能整理 REST 或 GraphQL 边界、OpenAPI、分页和错误响应，交付契约草稿及兼容检查。规范建议不能擅自更换已有 URL，也不代表接口已经部署。方法可本地学习，真实联调需授权环境；令牌只走安全配置，实际写库与开放接口先确认，错误路径和跨公司权限都要测试。

上游能力依据

上游原始适用说明：Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

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

Core Workflow
Reference Guide
Constraints
MUST DO
MUST NOT DO
Templates
OpenAPI 3.1 Resource Endpoint (copy-paste starter)
RFC 7807 Error Response (copy-paste)
Output Checklist
Knowledge Reference

使用边界

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

作者、翻译与许可证

原作者: Jeffallan 与 claude-skills contributors
中文翻译: CEOFans翻译
许可证: MIT
上游来源: https://github.com/Jeffallan/claude-skills/tree/1be15d8064f88fc25216442406d40add8fd23b53/skills/api-designer

适用范围

平台：linux、macos、windows；标签：架构与规划、接口契约与错误响应设计、开源技能

安全提示

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

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