未古其人

目录

前后端通信规范

1. 前后端请求只使用 GETPOST,具体内容参考请求格式

2. 后端返回给前端的数据格式,如:

{
	code: 200, // 表示请求是否正确执行(和业务无关,哪怕业务出错,只要请求正常执行,这里也返回 200 ,此处编码采用 http 状态码)
	message: "返回值提示信息", // 返回的提示
	body: { // 返回的具体内容
		success: true, // 当前业务请求成功与否的标志
		value: {} // 业务请求返回的数据
	}
}

3. 列表功能除非是特殊需求,都要进行分页,返回的数据格式如下:

{
	list: [], // 列表数据
	paging: {
		total: 103, // 总条数
		current: 1, // 当前页
		size: 20 // 每页条数
	}
}

4. 前后端通信时,所有数字均用字符串格式传输,前后端各自做格式转化;

5. 所有接口设计尽量符合 RESTFul 的要求;

6. 如果没有特殊情况,一个对象必须拥有增(add)、删(del)、改(edit)、列表(list)、详情(detail),五个接口;

7. 所有接口,都要以 模块名/功能名 的形式来命名;

请求格式

功能 方法明 请求方式 备注
添加 add POST  
删除 del GET  
编辑 edit POST / PUT  
列表 list GET  
详情 detail GET