发表于: 2020-01-03 22:59:51

1 993


今天完成的事:

1、编写接口文档。

前台用户管理、个人中心、用户绑定、文件上传通用接口。

1、前台用户列表:

简要描述:

  • 前台用户列表接口,需展示总用户人数
  • 有条件时,条件查询,其中名称查询为模糊查询,逆袭豆查询为范围查询
  • 无条件时,展示列表

请求URL:

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/user/list/search

请求方式:

  • GET

请求参数:

参数名必选类型说明
pageNumbernumber当前页码,默认为1
pageSizenumber当前页码显示数,默认为10
idnumber用户id
namestring用户名称
phonenumber手机号
emailstring邮箱
gradestring年级
scorenumber逆袭豆积分
statusnumber用户状态,1为解冻,0为冻结,默认为1

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success",
  4.    "data": {
  5.        "user_sum": 100,
  6.        "users": {
  7.            "pageNum": 1,
  8.            "pageSize": 10,
  9.            "total": 2,
  10.            "pages": 1,
  11.            "list": [
  12.                {
  13.                    "id": 1,
  14.                    "name": "用户一",
  15.                    "img": "https://jnshu.com/image/123456.jpg",
  16.                    "phone": 12345678901,
  17.                    "email": "www.nishuoshenme.com",
  18.                    "grade": "高一",
  19.                    "score": 1212,
  20.                    "status": 1
  21.                },
  22.                {
  23.                    "id": 2,
  24.                    "name": "用户二",
  25.                    "img": "https://jnshu.com/image/123.jpg",
  26.                    "phone": 12345678901,
  27.                    "email": "www.nishuoshenme.com",
  28.                    "grade": "高一",
  29.                    "score": 1212,
  30.                    "status": 0
  31.                }
  32.            ]
  33.        }
  34.    }
  35.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataarray数据信息

data数据说明

参数名类型说明
user_sumnumber前台用户总人数
idnumber用户主键id
namestring账号名称
imgstring头像地址(oss链接)
phonenumber手机号
emailstring邮箱
gradestring年级
scorenumber逆袭豆积分
statusnumber用户状态,1为解冻,0为冻结,默认为1

2、用户状态修改:

简要描述:

  • 用户状态修改接口,每次访问都修改用户状态,冻结为0,解冻为1

请求URL:

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/user/{id}

请求方式:

  • GET

请求参数:

参数名必选类型说明
idnumber用户id

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success"
  4.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

1、用户信息编辑(数据回显):

简要描述:

  • 用户信息编辑(数据回显)接口,可修改名称、头像、年级

请求URL:

  • dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/{id}

请求方式:

  • GET

请求参数:

参数名必选类型说明
idnumber用户id

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success",
  4.    "data": {
  5.        "id": 1,
  6.        "name": "用户一二",
  7.        "avatar_url": "http://jnshu.com/image/111.jpg",
  8.        "grade": "高一",
  9.        "score": 120
  10.    }
  11.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data数据说明

参数名类型说明
idnumber主键id
namestring账号名称
avatar_urlstring头像url地址
gradestring年级
scorenumber逆袭豆积分

2、用户信息编辑(数据提交):

简要描述:

  • 用户信息编辑(数据提交)接口

请求URL:

  • dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/{id}

请求方式:

  • PUT

请求参数:

参数名必选类型说明
idnumber用户id
namestring账号名称
avatar_urlstring头像url地址
gradestring年级

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success"
  4.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

1、用户(手机号)验证:

简要描述:

  • 用户(手机号)验证接口,发送验证码

请求URL:

  • dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/phone

请求方式:

  • POST

请求参数:

参数名必选类型说明
phonenumber用户手机号

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success"
  4.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

2、用户(手机号)绑定:

简要描述:

  • 用户(手机号)绑定接口,输入验证码,与手机号进行绑定

请求URL:

  • dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/phone/verify

请求方式:

  • POST

请求参数:

参数名必选类型说明
phonenumber用户手机号
codenumber手机验证码

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success"
  4.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

3、用户(邮箱)验证:

简要描述:

  • 用户(邮箱)验证接口,发送验证码

请求URL:

  • dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/email

请求方式:

  • POST

请求参数:

参数名必选类型说明
emailstring用户邮箱

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success"
  4.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

2、用户(邮箱)绑定:

简要描述:

  • 用户(邮箱)绑定接口,输入验证码,与邮箱进行绑定

请求URL:

  • dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/email/verify

请求方式:

  • POST

请求参数:

参数名必选类型说明
emailnumber用户邮箱
codenumber邮箱验证码

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success"
  4.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

1、上传文件(图片、视频):

简要描述:

  • 通用接口,上传文件(图片、视频)接口,选择文件后上传,返回url地址

请求URL:

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/upload

请求方式:

  • POST

请求参数:

参数名必选类型说明
filefile文件(图片、视频)

返回示例

  1.  {
  2.    "code": 200,
  3.    "msg": "success",
  4.    "data": {
  5.        "file_url": "http://jnshu.com/image/111.jpg"
  6.    }
  7.  }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data数据说明

参数名类型说明
file_urlstring文件url地址
明天计划的事:
1、继续编写接口文档、新建表格。
遇到的问题:
收获:
1、编写部分接口文档

返回列表 返回列表
评论

    分享到