【接口说明文档】

  1. 接口说明
  1. 接口中一般包含必要的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

}

返回列表,不带分页

[

 {数据对象},

 {数据对象}

]

[]

返回对象

{数据对象}

“”

  1. 支持的请求方法
  1. GET(SELECT):从服务器取出资源(一项或多项),所有查询类接口都使用此方法,程序中有涉及修改数据的除外。
  2. POST(CREATE):在服务器新建一个资源,所有涉及修改数据的接口都使用方法。
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值