# API接口规范 ## 消息规范 系统使用统一的消息返回机制，所有的API返回JSON数据，格式一致。如果所请求的API需要授权，而用户没有获得授权，直接抛出HTTP:401错误，客户端检测到401状态直接跳转到登录页面进行授权。 ```json { errno: 1000, errmsg: '错误消息', data: {} } ``` | 字段 | 含义 | 说明 | | ------ | ------ | ------ | | errno | 错误代码 | 通常返回 0，表示请求正常返回接口数据；如果请求出错，返回具体的错误代码，并在data字段返回错误的附加信息 | | errmsg | 错误消息 | 返回数据的解释性描述文字 | | data | 返回的业务数据 | 一般返回对象格式 | ## 错误代码 | 错误代码 | 含义 | 说明 | | ------ | ------ | ------ | | 0 | 正常返回 | 请求的接口正确的返回业务数据，非0表示请求出错 | | 1000 | 一般错误 | 通用的错误代码 | | 1001 | 请求接口参数校验错误 | 参数格式、类型不正确等 |