前后台分离开发下的统一返回数据格式

最新推荐文章于 2023-10-12 14:42:17 发布

原创

最新推荐文章于 2023-10-12 14:42:17 发布 · 800 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#java #json

在前后台分离的开发模式下，为了保证接口数据的一致性和易用性，通常会设定统一的JSON返回格式。内容通常包括状态码、返回消息和具体数据等字段。例如，对于分页、无数据和失败情况，都会有一个标准的结构来描述这些场景。

一、统一返回数据格式

项目中我们会将响应封装成json返回，一般我们会将所有接口的数据格式统一，使前端(iOS Android, Web)对数据的操作更一致、轻松。
一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容
例如，我们的系统要求返回的基本数据格式如下：

{
   
   
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
   
   
    "items": [
      {
   
   
        "id": "1",
        "name": "刘德华",
        "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"
      }
    ]
  }
}

分页：

{
   
   
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
   
   
    "total": 17,
    "rows": [
      {
   
   
        "id": "1",
        "name": "刘德华",
        "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"