加入收藏 | 设为首页 | 会员中心 | 我要投稿 核心网 (https://www.hxwgxz.com/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 建站 > 正文

谈谈前后分离接口规范

发布时间:2019-07-19 23:37:26 所属栏目:建站 来源:儒雅程序员
导读:1. 前言 随着互联网的高速发展,前端页面的展示、交互体验越来越灵活、炫丽,响应体验也要求越来越高,后端服务的高并发、高可用、高性能、高扩展等特性的要求也愈加苛刻,从而导致前后端研发各自专注于自己擅长的领域深耕细作。 然而带来的另一个问题:前

1.GET请求:

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

2.POST请求:

前后分离接口规范

POST请求

5.2.2 响应基本格式

  1.  code: 200, 
  2.  data: { 
  3.  message: "success" 
  4.  } 

1.code : 请求处理状态

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

2.data.message: 请求处理消息

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

5.3 响应实体格式

  1.  code: 200, 
  2.  data: { 
  3.  message: "success", 
  4.  entity: { 
  5.  id: 1, 
  6.  name: "XXX", 
  7.  code: "XXX" 
  8.  } 
  9.  } 

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

5.4 响应列表格式

  1.  code: 200, 
  2.  data: { 
  3.  message: "success", 
  4.  list: [ 
  5.  { 
  6.  id: 1, 
  7.  name: "XXX", 
  8.  code: "XXX" 
  9.  }, 
  10.  { 
  11.  id: 2, 
  12.  name: "XXX", 
  13.  code: "XXX" 
  14.  } 
  15.  ] 
  16.  } 

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

5.5 响应分页格式

  1.  code: 200, 
  2.  data: { 
  3.  recordCount: 2, 
  4.  message: "success", 
  5.  totalCount: 2, 
  6.  pageNo: 1, 
  7.  pageSize: 10, 
  8.  list: [ 
  9.  { 
  10.  id: 1, 
  11.  name: "XXX", 
  12.  code: "H001" 
  13.  }, 
  14.  { 
  15.  id: 2, 
  16.  name: "XXX", 
  17.  code: "H001" 
  18.  } ], 
  19.  totalPage: 1 
  20.  } 

data.recordCount: 当前页记录数 data.totalCount: 总记录数 data.pageNo: 当前页码 data.pageSize: 每页大小 data.totalPage: 总页数

5.6 特殊内容规范

5.6.1 下拉框、复选框、单选框

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

  1.  code: 200, 
  2.  data: { 
  3.  message: "success", 
  4.  list: [{ 
  5.  id: 1, 
  6.  name: "XXX", 
  7.  code: "XXX", 
  8.  isSelect: 1 
  9.  }, { 
  10.  id: 1, 
  11.  name: "XXX", 
  12.  code: "XXX", 
  13.  isSelect: 0 
  14.  }] 
  15.  } 

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

5.6.2 Boolean类型

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

5.6.3 日期类型

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

6. 未来的大前端

目前我们现在用的前后端分离模式属于第一阶段,由于使用到的一些技术jquery等,对于一些页面展示、数据渲染还是比较复杂,不能够很好的达到复用。对于前端还是有很大的工作量。

下一阶段可以在前端工程化方面,对技术框架的选择、前端模块化重用方面,可多做考量。也就是要迎来“==前端为主的 MV* 时代==”。 大多数的公司也基本都处于这个分离阶段。

最后阶段就是==Node 带来的全栈时代==,完全有前端来控制页面,URL,Controller,路由等,后端的应用就逐步弱化为真正的数据服务+业务服务,做且仅能做的是提供数据、处理业务逻辑,关注高可用、高并发等。

(编辑:核心网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

热点阅读