SuperAPI AI 工具集

api-design-safety

编程与开发

查看项目

更新于 10-15 21:11

技能介绍

用途:在设计与修改 REST API 响应结构、处理 API 返回值时提供规范,防止字段错位、类型歧义等问题。

主要能力:归纳了四类常见缺陷及对策。一是泛型方法重载歧义:当返回 String 时,Java 重载可能优先匹配 success(String message) 而非 success(T data),导致数据写入错误字段;可通过明确指定 message 参数、显式泛型或包装 DTO 规避。二是字段语义:code 为 int 业务状态码,message 为用户可读提示,data 为业务数据,timestamp 为 ISO 8601 时间戳,避免把业务数据放进 message 或让 message 暴露技术细节。三是空值一致性:单对象不存在返回 data: null,列表为空返回 [],分页为空返回 {list: [], total: 0}。四是状态码分层:HTTP 状态码用于传输层(200/401/403/500),业务失败返回 HTTP 200 加业务 code 字段,仅代码异常才用 HTTP 500。

适用场景:Spring Boot、Gin/Echo、Express/Koa、FastAPI/Flask 等 REST API 开发。

限制:资料未提供具体安装或调用命令、版本兼容信息与配套测试实现细节,暂未提供。