API 返回数据结构设计怎么做
restful api 返回数据结构大家都是怎么设计的,如何包含错误信息或者额外信息呢?有没最佳实践或者大公司都是怎么做的。
我们习惯把数据和附属信息分开,大概是这样的:
interface CommonResponse<T> {
data: T; // 返回具体数据结构
paging: {
next: string; // 用于 cursor base 分页
prev: string; // 用于 cursor base 分页
size: number; // 用于 offset,size 分页
offset: number; // 用于 offset,size 分页
};
error: {
code: number; // 错误码
message: string;// 详细错误信息
};
}