JSON:API接口规范设计
接收接口定义或响应报文,按JSON:API标准核对字段层级、状态码与关联格式,输出规范的响应载荷与修正方案。
功能与用途
用于在开发或重构 RESTful API 时严格遵循 JSON:API v1.1 协议规范。用户只需提供拟定的接口路由、请求载荷或响应数据,即可自动核查是否满足 application/vnd.api+json 媒体类型、顶层结构规范(如 data 与 errors 互斥、id 强制字符串且 type 采用 kebab-case)、标准 HTTP 状态码映射及 include 复合文档关系,输出完全符合规范的报文结构与修改建议。
适用场景
- 接口响应报文合规检查:审查现有接口的成功与报错返回结构,排查字段嵌套、类型格式与状态码不合规问题并生成修正模板。
- 关联资源与复合文档设计:规划一对一及一对多关系的更新接口,构建支持 include 参数的复合响应文档与外键关联结构。
- 规范化错误响应构造:按规范生成标准错误数组对象,包含对应 HTTP 状态码、统一错误标题及精确到字段的指针定位。
适用人群
- 后端开发工程师
- API架构师
- 接口测试工程师
使用步骤
- 提供拟设计或待审查的 API 路由、请求参数及返回 JSON 报文。
- 依据 JSON:API 规范核验媒体类型、顶层结构互斥性与字段类型。
- 审查关系嵌套、查询参数命名及对应 HTTP 状态码是否符合规范。
- 获取合规的 JSON:API 数据载荷定义及针对不合规项的修改指导。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 进阶
- 版本
- master
- 最近更新
- 2026-09-28
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
>
依赖与权限
- 读取用户主动提供的内容