原文链接：前后端共识

HTTP请求类型篇

1严格遵守规范  POST,DELETE,PUT,GET 对应增删改查（前端非get请求会抛出msg后端业务信息提示）

RESTFUl规范详情点击传送门

HTTP媒体类型篇

1 对前端友好的媒体类型是'application/json;charset=UTF-8';

2 复杂的入参结构请不要使用application/x-www-urlencoded

HTTP****响应格式篇

一：响应基本格式

成功

{

    "succ": true,                          // 是否成功

    "ts": 1566386951005,           // 时间戳

    "data": "test",                       // 数据

    "code": null,                         // 错误类型

    "msg": null,                          // 错误描述

}

失败

{

1. code: "CLOUD-500"
2. msg: "服务器开小差，请稍后再试"
3. succ: false
4. ts: 1629792906664

}

{

1. code: "GK400"
2. data: null
3. msg: "请求无效！【桶名已存在！】"
4. succ: false
5. ts: 1629793044511

}

{

1. code: null
2. data: "删除成功！"
3. msg: "[traceId:7591f2a55d2d5e24][spanId:d5cb2bbe4acb5a36]"
4. succ: true
5. ts: 1629794612070

}

二：特殊实体结构

1. 树形结构

![]( "Polaris-团队资料 > 前后端共识 > image2021-8-23_9-42-23.png")

![]( "Polaris-团队资料 > 前后端共识 > image2021-8-23_10-12-28.png")

 2.分页结构

 queryParams  {page当前页}

 response  {items:[],page,total}

入参
page	页码
pageSize	页面大小

出参
total	总数量
items	数据详情
page	当前页码

![]( "Polaris-团队资料 > 前后端共识 > image2021-8-24_16-10-5.png")

三：特殊实体字段类型

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

      2关于日期类型，JSON数据传输中一律使用字符串，具体日期格式因业务而定；yyyy-MM-dd HH:mm:ss

四：传参

1.统一时间参数名称

   开始时间：startTime

   结束时间：endTime

2.下拉框统一传参类型

传id（int）（如创建人，任务名称 传用户id，任务id）

3.返参中各id的命名规则

![]( "Polaris-团队资料 > 前后端共识 > idname.png")

id只能是当前对象自身的，其他属性id的命名规则为（表名_id）