api-design-safety
Installation
SKILL.md
API 设计安全规范
当设计或修改 REST API 响应结构时,防止常见的设计缺陷。
陷阱 #1: 泛型方法重载歧义
场景: 返回类型为 String 时,Java 重载解析可能匹配错误的方法
问题根因
Java 方法重载解析时,String 类型参数会优先匹配 success(String message) 而非 success(T data),导致数据进入错误的字段。
错误示例
// ApiResponse 有两个重载:
public static <T> ApiResponse<T> success(T data)
Related skills
More from doccker/cc-use-exp
java-dev
Java 开发规范,包含命名约定、异常处理、Spring Boot 最佳实践等
336frontend-dev
前端开发规范,包含 Vue 3 编码规范、UI 风格约束、TypeScript 规范等
56go-dev
Go 开发规范,包含命名约定、错误处理、并发编程、测试规范等
38python-dev
Python 开发规范,包含 PEP 8 风格、类型注解、异常处理、测试规范等
37ops-safety
当用户执行系统级命令(sysctl、iptables、systemctl、Docker 配置、数据库 DDL)或进行服务器运维操作时触发。提供运维安全规范。
35bash-style
当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件,或在 Markdown 中编写 bash 代码块时触发。提供 Bash 编写规范。
35