- 接口说明
- 接口中一般包含必要的3个参数:code message data
状态码 | 含义 | 说明 |
200 | 请求成功 | 包括查询、新增、修改、删除,统一返回此状态码 |
204 | 查询不到所需的对象数据 | 在返回值是单个对象的查询接口中,如果服务端根据查询参数查询不到结果,返回此状态码 |
301 | 获取不到token,token认证失败 | 需要重新登录 |
302 | token过期,token认证失败 | 需要重新登录 |
303 | token访问异常,token认证失败 | 需要重新登录 |
304 | 用户不存在,token认证失败 | 需要重新登录 |
305 | 非法访问,token认证失败 | 需要重新登录 |
500 | 程序处理错误 | 接口内部处理出现异常,需要尽可能的在返回的信息中表明发生错误的原因 |
501 | 可解决的程序处理错误 | 错误的等级低于500,标识可以由用户在页面中修改参数或其他操作可以解决的错误,需在返回的信息中表明发生错误的原因,如参数错误或逻辑错误等 |
code:返回编码
message:返回的信息提示
data:返回的数据
data返回类型 | 不为空返回 | 为空返回 |
返回列表,带分页 | { “content”:[//列表内容 {}, {} ], “count”:”总条数”, “pageMax”:”最大页数” } | { “content”:[], “count”:0, “pageMax”:0 } |
返回列表,不带分页 | [ {数据对象}, {数据对象} ] | [] |
返回对象 | {数据对象} | “” |
- 支持的请求方法
- GET(SELECT):从服务器取出资源(一项或多项),所有查询类接口都使用此方法,程序中有涉及修改数据的除外。
- POST(CREATE):在服务器新建一个资源,所有涉及修改数据的接口都使用方法。