设计API返回内容的约定与实践

在设计API返回内容时,通常需要与前端约定好API返回响应体内容的格式。这样方便前端进行数据反序列化时相应的解析处理,也方便其它服务调用。不同公司有不同的响应内容规范要求,这里以常见的JSON响应体为例:

JSON响应体示例

code状态码主要用于表示错误类型区间状态码。如果设计比较简单,可以直接使用HTTP的状态码。如果是一个大型系统,也可以设计一套自定义的状态码。比如:

自定义状态码示例

message字段是对当前 code 状态码错误明细的补充说明。通常不同的code状态码会有不同的message描述信息。

data 值通常代表返回的响应体内容。

以下代码定义了一个JSON响应类,api在返回的时候需要引用这个响应类。除此之外,还对404和一般异常做了统一处理,当出现这两类异常时,也会返回JSON结构的响应体。

示例代码

客户端请求测试:

客户端请求测试

标签:游戏攻略