发表于: 2020-01-03 22:59:51
1 993
1、编写接口文档。
前台用户管理、个人中心、用户绑定、文件上传通用接口。
1、前台用户列表:
简要描述:
- 前台用户列表接口,需展示总用户人数
- 有条件时,条件查询,其中名称查询为模糊查询,逆袭豆查询为范围查询
- 无条件时,展示列表
请求URL:
dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/user/list/search
请求方式:
- GET
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
pageNumber | 否 | number | 当前页码,默认为1 |
pageSize | 否 | number | 当前页码显示数,默认为10 |
id | 否 | number | 用户id |
name | 否 | string | 用户名称 |
phone | 否 | number | 手机号 |
否 | string | 邮箱 | |
grade | 否 | string | 年级 |
score | 否 | number | 逆袭豆积分 |
status | 否 | number | 用户状态,1为解冻,0为冻结,默认为1 |
返回示例
{
"code": 200,
"msg": "success",
"data": {
"user_sum": 100,
"users": {
"pageNum": 1,
"pageSize": 10,
"total": 2,
"pages": 1,
"list": [
{
"id": 1,
"name": "用户一",
"img": "https://jnshu.com/image/123456.jpg",
"phone": 12345678901,
"email": "www.nishuoshenme.com",
"grade": "高一",
"score": 1212,
"status": 1
},
{
"id": 2,
"name": "用户二",
"img": "https://jnshu.com/image/123.jpg",
"phone": 12345678901,
"email": "www.nishuoshenme.com",
"grade": "高一",
"score": 1212,
"status": 0
}
]
}
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
data | array | 数据信息 |
data数据说明
参数名 | 类型 | 说明 |
---|---|---|
user_sum | number | 前台用户总人数 |
id | number | 用户主键id |
name | string | 账号名称 |
img | string | 头像地址(oss链接) |
phone | number | 手机号 |
string | 邮箱 | |
grade | string | 年级 |
score | number | 逆袭豆积分 |
status | number | 用户状态,1为解冻,0为冻结,默认为1 |
2、用户状态修改:
简要描述:
- 用户状态修改接口,每次访问都修改用户状态,冻结为0,解冻为1
请求URL:
dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/user/{id}
请求方式:
- GET
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | 是 | number | 用户id |
返回示例
{
"code": 200,
"msg": "success"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
1、用户信息编辑(数据回显):
简要描述:
- 用户信息编辑(数据回显)接口,可修改名称、头像、年级
请求URL:
dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/{id}
请求方式:
- GET
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | 是 | number | 用户id |
返回示例
{
"code": 200,
"msg": "success",
"data": {
"id": 1,
"name": "用户一二",
"avatar_url": "http://jnshu.com/image/111.jpg",
"grade": "高一",
"score": 120
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
data | object | 数据信息 |
data数据说明
参数名 | 类型 | 说明 |
---|---|---|
id | number | 主键id |
name | string | 账号名称 |
avatar_url | string | 头像url地址 |
grade | string | 年级 |
score | number | 逆袭豆积分 |
2、用户信息编辑(数据提交):
简要描述:
- 用户信息编辑(数据提交)接口
请求URL:
dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/{id}
请求方式:
- PUT
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
id | 是 | number | 用户id |
name | 否 | string | 账号名称 |
avatar_url | 否 | string | 头像url地址 |
grade | 否 | string | 年级 |
返回示例
{
"code": 200,
"msg": "success"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
1、用户(手机号)验证:
简要描述:
- 用户(手机号)验证接口,发送验证码
请求URL:
dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/phone
请求方式:
- POST
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
phone | 是 | number | 用户手机号 |
返回示例
{
"code": 200,
"msg": "success"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
2、用户(手机号)绑定:
简要描述:
- 用户(手机号)绑定接口,输入验证码,与手机号进行绑定
请求URL:
dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/phone/verify
请求方式:
- POST
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
phone | 是 | number | 用户手机号 |
code | 是 | number | 手机验证码 |
返回示例
{
"code": 200,
"msg": "success"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
3、用户(邮箱)验证:
简要描述:
- 用户(邮箱)验证接口,发送验证码
请求URL:
dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/email
请求方式:
- POST
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
是 | string | 用户邮箱 |
返回示例
{
"code": 200,
"msg": "success"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
2、用户(邮箱)绑定:
简要描述:
- 用户(邮箱)绑定接口,输入验证码,与邮箱进行绑定
请求URL:
dev.home.daoxiangzhe.xiuzhenyuan.cn/b/user/email/verify
请求方式:
- POST
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
是 | number | 用户邮箱 | |
code | 是 | number | 邮箱验证码 |
返回示例
{
"code": 200,
"msg": "success"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
1、上传文件(图片、视频):
简要描述:
- 通用接口,上传文件(图片、视频)接口,选择文件后上传,返回url地址
请求URL:
dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/upload
请求方式:
- POST
请求参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
file | 是 | file | 文件(图片、视频) |
返回示例
{
"code": 200,
"msg": "success",
"data": {
"file_url": "http://jnshu.com/image/111.jpg"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | number | 状态码 |
msg | string | 状态信息 |
data | object | 数据信息 |
data数据说明
参数名 | 类型 | 说明 |
---|---|---|
file_url | string | 文件url地址 |
评论