AI Skill 大全

REST API 响应设计检查

提供接口代码或响应示例,检查字段语义、空值和状态码设计,找出前后端解析风险并给出修改建议。

功能与用途

用于设计或修改 REST API 响应时检查常见问题。提供接口实现、响应示例和前端解析方式后,可以检查业务数据是否放错字段、空对象与空列表是否一致,以及 HTTP 状态码和业务状态码是否容易混淆。对于 Java 接口,还会关注字符串返回值可能遇到的方法重载问题,并提出修改与测试建议。适合有基本接口开发经验的用户;状态码方案应结合项目现有约定确认。

适用场景

  • 排查上传接口字段错位:检查文件地址是否被放进 message 而非 data,并核对 Java 响应方法的实际重载。
  • 统一列表接口空值:检查空列表和空分页的响应结构,减少前端遍历或读取总数时的异常。
  • 检查错误响应约定:对照项目接口规范检查 HTTP 状态码、业务状态码和用户提示信息。
  • 核对前后端响应解析:比较接口响应与前端取值代码,定位 data 字段读取和空值处理问题。

适用人群

  • 后端开发工程师
  • 前端开发工程师
  • 全栈开发工程师
  • 接口测试工程师

使用步骤

  1. 提供接口代码、响应示例或设计草案。
  2. 补充项目的状态码约定和前端解析代码。
  3. 说明遇到的字段错位或空值问题。
  4. 查看检查结果,按项目约定修改并补充测试。

开始使用

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

查看 MCP 接入说明

技术信息

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

当设计或修改 REST API 响应结构、处理 API 返回值时触发。防止 API 设计缺陷导致的字段错位、类型歧义等问题。

依赖与权限

  • YOUR_PORT

同类 Skill