在开发 RESTful API 时,为了保持响应结构的一致性,公司内部一般都有标准化的响应格式。这不仅可以提高代码的可维护性,还可以帮助前端开发者更容易地处理和解析 API 响应。将展示如何在 Spring Boot 中创建一个自定义响应参数工具类,然后使用它进行返参给前端。
设计响应模型
在前后端分离项目中,前端和后端一般都是以 JSON 格式进行数据交互。而在数据格式设计上,每个公司基本大同小异,小哈习惯这样设计,如下:
接口执行成功返参格式
{
"success": true,
"data": null
}
success
: 是否请求成功,布尔型,true
表示接口请求成功,false
表示执行失败;data
: 服务端响应数据,对象类型;
接口执行异常返参格式
{
"success": false,
"errorCode": "10000"
"message": "用户名不能为空"
}
message
: 服务端响应消息,字符串类型,当