Skip to content
chaowen edited this page Sep 28, 2021 · 3 revisions

基本说明

后端接口统一baseUrl

https://sp.bistucetc.com/backendApi/

登录验证

接口采用token的方式来保证前端与后端间的身份验证。前端访问登录接口,后端返回一个token,之后每次访问后端接口都需要在header中带上token(token=xxxx)。token具有时间限制,该限制可由后端修改。

除了登录接口和用户信息完善接口外,所有接口都需要携带后端下发的登录token。

传参说明

  1. 前端所有提交的数据以json形式提交。

  2. 所有参数递交的方式必须为POST,默认的MIME类型为application/json,参数值编码为utf-8。

  3. 所有的字段都使用驼峰形式,如:user_name改为userName。

返回/通知结果

所有接口统一返回json数据,数据结构如下:

{
    "code":200,
    "message":"success",
    "data":{
        "id":xxx,
        "token":xxx,
        "address":xxx,
        "major":{
			...
    	}
    }
}

code表示接口结果的状态码,message对code做简单表述,data是有效载荷。

分页接口说明

凡是提供分页功能的接口,满足以下规则:

  • 如果没有填写current或size数据,那么默认值分别为1和10,即以每页10条的规格,获取第一页的所有数据。
  • 如果不想分页,令current<=0即可。
  • 如果请求的页数不存在(实际页数不够),那么返回空列表。

Clone this wiki locally