api响应数据格式约定规范

统一封装格式


{
	"status": 0,
	"success": true,
	"message": "",
	"data": {
	}
}

业务数据规范

  • isass 采用前后端分离的架构模式,后端提供的数据模型格式,应该是与业务本身涉及到的各个 领域模型 一致的,能直观地体现领域模型本身的互相关系。以便能提供统一的领域模型格式给各端调用。

  • 各前端根据产品规划,同一种数据,可能出现不同的 ui 展现形式,各端在代码层面,应该有自身的 ui数据模型,在接收到后端数据返回后,应该将后端数据模型,转换成自身的 ui数据模型,用于 ui 展示

  • 各前端原则上不应该要求后端的返回数据按照前端的 ui 结构进行变更,原因如下:

违反了第一条规范,造成接口数据不能体现领域模型的互相关系

造成接口不能统一给各端使用,导致每端都要新增独立接口,增大工作量,背离前后端分离的意义

造成接口数据格式不统一,增大了各端相互协助的沟通成本

前端代码架构

各前端可采用以下代码架构模式,统一各端,统一业务流程,提高各端协同效率

front-architecture