AI Skill 大全

API接口设计与契约审查

输入业务需求或现有接口契约,设计接口结构、请求响应与错误规范,产出便于前后端对接的方案和文档。

功能与用途

适用于新建接口或梳理已有接口规范。提供业务资源、操作需求、权限要求或现有接口契约后,可设计REST端点与GraphQL类型、查询和变更,明确请求字段、返回结构、分页、错误码、认证和版本策略。结果包括接口设计方案、请求响应示例、契约审查意见,并可整理REST接口的OpenAPI文档。使用者需了解基本接口概念,并提供关键业务约束,便于开发与联调。

适用场景

  • 新业务接口设计:为用户、订单等业务资源设计REST端点,明确请求字段、分页方式、返回结构和权限要求。
  • 已有接口契约审查:检查接口命名、HTTP方法、错误响应和认证约定,输出不一致之处及修改建议。
  • GraphQL数据接口规划:围绕关联业务对象设计类型、查询与变更,规划嵌套资源和分页结构。
  • 接口文档与版本规划:将REST接口方案整理为OpenAPI文档,并明确版本路径、限流响应头和错误示例。

适用人群

  • 后端开发工程师
  • 全栈开发工程师
  • 负责接口规范的技术负责人
  • 参与接口联调的前端工程师

使用步骤

  1. 提供业务需求或现有接口契约。
  2. 说明采用REST或GraphQL及主要业务约束。
  3. 梳理资源关系、接口结构和请求响应字段。
  4. 补充错误处理、认证、分页与版本策略。
  5. 获取设计文档或审查意见,核对业务覆盖情况。

开始使用

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

查看 MCP 接入说明

技术信息

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

Designs REST and GraphQL APIs including endpoints, error handling, versioning, and documentation. Use when creating new APIs, designing endpoints, reviewing API contracts, or when asked about REST, GraphQL, or API patterns.

使用前准备

  • 了解HTTP、JSON及基本接口概念。
  • 提供业务资源、操作需求和权限约束;审查时需提供现有接口契约。
  • 生成完整OpenAPI文档时,应确认配套模板可用或提供现有规范文件。

依赖与权限

  • AUTH_SECRET
  • API_KEY

同类 Skill