前后端分离之接口设计规范

标签：code 请求 分离 接口 设计规范 message data name

如何做分离 

职责分离

• 前后端仅仅通过异步接口来编程
• 前后端都各自有自己的开发流程，构建工具，测试集合
• 关注点分离，前后端变得相对独立并松耦合

开发流程

• 后端编写和维护接口文档，在 API 变化时更新接口文档
• 后端根据接口文档进行接口开发
• 前端根据接口文档进行开发 + Mock平台
• 开发完成后联调和提交测试

Mock 服务器根据接口文档自动生成 Mock 数据，实现了接口文档即API：

接口规范

规范原则

• 接口返回数据即显示：前端仅做渲染逻辑处理；
• 渲染逻辑禁止跨多个接口调用；
• 前端关注交互、渲染逻辑，尽量避免业务逻辑处理的出现；
• 请求响应传输数据格式：JSON，JSON数据尽量简单轻量，避免多级JSON的出现；

基本格式示例

下文开始给出一个前后端交互数据的基本示例，具体大家可以根据自己的业务或者编码习惯做些许调整，切勿拘泥于文中示例！

• 请求基本格式

所有请求数据包装为JSON格式，示例如下：

GET请求：

xxx/login?body={"username":"admin","password":"123456","captcha":"scda","rememberMe":1}

POST请求：

• 响应基本格式

{
  code:200,
  data:{
  	message:"success"
  }
}

code：表示请求处理状态，示例值如下:

200: 请求处理成功
500: 请求处理失败
401: 请求未认证，跳转登录页
406: 请求未授权，跳转未授权提示页

data.message: 表示请求处理消息:

code=200 且 data.message="success": 请求处理成功
code=200 且 data.message!="success": 请求处理成功, 普通消息提示：message的内容
code=500: 请求处理失败，警告消息提示：message的内容

• 响应实体格式

{
  code:200,
  data:{
  	message:"success",
    entity:{
    	id:1,
      name:"madder",
      "age":28,
      "sex":2
    }
  }
}

data.entity: 响应返回的实体数据

• 响应列表格式

{
  code:200,
  data:{
  	message:"success",
    list:[
      {
        "id":1,
        "name":"tony",
        "age":28,
        "sex":1
      },
      {
        "id":2,
        "name":"Jerry",
        "age":30,
        "sex":2
      }
    ]
  }
}

data.list: 响应返回的列表数据

• 响应分页格式

{
  code:200,
  data:{
    recordCount:2,
  	message:"success",
    totalCount:2,
    pageNo:1,
    pageSize:10,
    list:[
      {
        "id":1,
        "name":"tony",
        "age":28,
        "sex":1
      },
      {
        "id":2,
        "name":"jerry",
        "age":30,
        "sex":2
      },
     {
        "id":3,
        "name":"pines",
        "age":35,
        "sex":1
      }
    ],
    totalPage:1
  }
}

data.recordCount: 当前页记录数

data.totalCount: 总记录数

data.pageNo: 当前页码

data.pageSize: 每页大小

data.totalPage: 总页数

• 特殊内容规范

下拉框、复选框、单选框

由后端接口统一逻辑判定是否选中，通过isSelect标示是否选中，示例如下：

{
  code:200,
  data:{
  	message:"success",
    list:[
      {
        "id":1,
        "name":"madder",
        "age":28,
        "sex":2,
        "isSelect":1
      },
      {
        "id":2,
        "name":"pines",
        "age":30,
        "sex":1,
         "isSelect":0
      }
    ]
  }
}

禁止下拉框、复选框、单选框判定选中逻辑由前端来处理，统一由后端逻辑判定选中返回给前端展示；

• Boolean类型

关于Boolean类型，JSON数据传输中一律使用1/0来标示，1为是/True，0为否/False；

• 日期类型

关于日期类型，JSON数据传输中一律使用字符串，具体日期格式因业务而定；

标签：code,请求,分离,接口,设计规范,message,data,name
From： https://www.cnblogs.com/liucs/p/17341923.html