饭卡管理系统(接口文档)
一、管理员端口
1、学生列表查询
id(隐藏) | 姓名 | 性别 | 头像 | 用户名 | 卡号 | 账号 | 余额 | 按钮 |
1 | 小马 | 男 | http…… | 小马 | 2577293893 | #C123 | 20.0 | 删除 编辑 |
2 | 小飞 | 男 | http…… | 小飞 | #C123 | 删除 编辑 |
基本信息
请求路径:/information
请求方式:GET
接口描述:多表查询,查询用户表中身份为“normal”的数据,获取到的用户信息id 关联饭卡表中的user_id字段,通过这个关联users表和cards表
(先查出所有“normal”的用户,再根据用户id在cards表中查询用户对应的饭卡信息)
请求参数
参数名 | 类型 | 是否必须 | 备注 |
role | String | 是 | 用户身份:admin-管理员 normal-学生 |
响应数据
{"code": 1,"msg": "success","data": [{"id": 1,"name": "学工部","gender": "2022-09-01T23:06:29","avatarUrl": "2022-09-01T23:06:29""account": 1,"cardNumber": "学工部","balance": "2022-09-01T23:06:29",},........]
}
2、删除用户信息
基本信息
请求路径:/information
请求方式:DELETE
接口描述:根据id删除用户
请求参数:
参数名 | 类型 | 是否必须 | 备注 |
ids | Long[ ] | 是 | 删除用户的id数组 |
响应数据:
{"code":1,"msg":"success","data":null
}
3、编辑用户信息
基本信息:
请求路径:/information
请求方式:PUT
接口描述:该接口用户修改用户的基本信息
请求参数:
参数格式:application/json
参数说明:
名称 | 类型 | 是否必须 | 备注 |
id | Long | 是 | 用户id(不可修改) |
name | String | 否 | 姓名 |
username | String | 否 | 用户名 |
avatarUrl | String | 否 | 头像 |
gender | Integer | 否 | 性别:0-女 1-男 |
cardNumber | String | 否 | 卡号 |
balance | BigDecimal | 否 | 余额 |
响应数据:
{"code":1,"msg":"success","data":null
}
4、挂失
挂失页面的表格信息来源:学生列表查询
id(隐藏) | 姓名 | 卡号 | 余额 | 状态 | 按钮 |
1 | 小马 | 2577293893 | 2.00 | 正常使用 | 挂失 |
2 | 小飞 | 23237837 | 8.88 | 挂失状态 | 接触挂失 |
基本信息
请求路径:/loss
请求方式:PUT
接口描述:该接口根据 用户id 修改 饭卡表 中饭卡的状态(挂失或者解除挂失)
请求参数:
参数名 | 类型 | 是否必须 | 备注 |
id | Long | 是 | 用户id |
响应数据:
{"code":1,"msg":"success","data":null
}
5、充值
基本信息:
请求路径:/rechange
请求方式:PUT
接口描述:该接口通过用户id 给用户名下的饭卡进行充值
请求参数:
参数格式:application/json
参数要求:
参数名 | 类型 | 是否必须 | 备注 |
cardId | Long | 是 | 饭卡id |
userId | Long | 是 | 用户id |
amount | BigDecimal | 是 | 充值金额 |
paymentMethod | String | 是 | 支付方式:微信支付or支付宝 |
响应数据:
{"code":1,"msg":"success","data":null
}
6、查询充值记录
基本信息:
请求路径:/rechange
请求方式:GET
接口描述:该接口通过用户id查询该用户的历史充值
请求参数:
参数名 | l类型 | 是否必须 | 备注 |
id | Long | 是 | 用户id |
响应数据:
{"code": 1,"msg": "success","data": [{"order_number": 1,"amount": "学工部","created_at": "2022-09-01T23:06:29","payment_method": "2022-09-01T23:06:29"},........]
}
7、发布公告
基本信息:
请求路径:/notice
请求方式:/PUT
接口描述:该接口用于管理员发布公告
请求参数:
参数格式:multipart/form-data
参数要求:
参数名 | 类型 | 是否必须 | 备注 |
user_id | Long | 是 | 用户id |
title | String | 是 | 标题 |
content | String | 是 | 内容 |
image_url | String | 是 | 图片路径 |
响应数据:
{"code":1,"msg":"success","data":null
}
8、用户反馈
基本信息:
请求路径:/feedback
请求方式:GET
接口描述:该接口用于获取全部用户的反馈
请求参数:无
响应数据: