AI Skill 大全

API与接口规范设计

接收业务需求或接口草案,基于契约优先、边界校验与幂等性等规范,生成前后端统一且难于误用的API与类型定义。

功能与用途

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

适用场景

  • REST与GraphQL端点规格设计:基于契约优先原则,为前后端团队定制资源化路径、类型定义与统一错误响应结构。
  • 第三方集成与外部输入边界防护:在接口层对不可信的外部服务回包及用户提交数据进行强校验,隔离脏数据风险。
  • 交易级接口幂等机制设计:基于幂等键派生与原子声明逻辑,杜绝网络重试引发的重复扣费或数据混乱。

适用人群

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

使用步骤

  1. 提供待设计的业务场景、核心操作模型或现有接口草案
  2. 应用契约优先原则,定义出符合 REST 规范的端点路径、查询参数、请求体及响应体结构
  3. 针对可能产生重复执行的写操作设计幂等键处理机制与边界参数校验规则
  4. 生成统一的错误结构体并使用对照清单自检接口规范性与向后兼容性

开始使用

将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。

查看 MCP 接入说明

技术信息

分类
编程
适用工具
Codex、Claude Code、OpenClaw、Hermes、国内 Agent
使用难度
进阶
版本
main
最近更新
2026-09-23
文件数
3
安装包大小
自动生成 ZIP
安全检查
基础检查通过

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