大学比赛的报修系统 api 文档
API 接口说明 v3.4.1
- 接口基准地址:
http://47.103.192.147:8080/ - 服务端已开启 CORS 跨域支持
- 使用 HTTP Status Code 标识状态
- API 统一使用 Token 认证(除了登陆、注册请求)
- 需要授权的 API ,必须在请求头中使用
Authorization字段提供token令牌 - 数据返回格式统一使用 JSON
支持的请求方法
- GET(SELECT):从服务器取出资源(一项或多项)。
- POST(CREATE):在服务器新建一个资源。
- PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
- PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
- DELETE(DELETE):从服务器删除资源。
通用返回状态说明
| 状态码 | 含义 | 说明 |
|---|---|---|
| 200 | OK | 请求成功 |
| 201 | CREATED | 创建成功 |
| 204 | DELETED | 删除成功 |
| 400 | BAD REQUEST | 请求的数据格式不符 |
| 401 | UNAUTHORIZED | 请求的数字签名不匹配 |
| 403 | FORBIDDEN | 被禁止访问 |
| 404 | NOT FOUND | 请求的资源不存在 |
| 500 | INTERNAL SERVER ERROR | 内部错误 |
| 503 | SERVER_BUSY | 服务器正忙,请稍后再试 |
检查登陆状态
浏览器和服务器之间时通过 Token 来确定连接状态,浏览器发起登陆成功服务端会自动生成一个 Token,服务器存一份 Token 到 redis 缓存数据库中并设置好超时时间 传回给浏览器,浏览器将这个 Token 存放在 localStorage 中,浏览器加个拦截器,每次访问服务器都把 Token 放在 Authorization 头里面,服务器得到这个 Token 后就可以判断这个用户是否登陆(或者是否登陆超时)

localStorage
存储在 localStorage 里面的数据在页面会持久的保存到本地,所以可以做免密登陆
// 保存数据到 localStorage
localStorage.setItem('key', 'value');
// 从 localStorage 获取数据
let data = localStorage.getItem('key');
// 从 localStorage 删除保存的数据
localStorage.removeItem('key');
// 从 localStorage 删除所有保存的数据
localStorage.clear();
返回的数据格式
{
"code": 200,
"message": "登录成功",
"data": {
...
}
}
通用工具 api
获取信息
- 请求路径:utils/get-info
- 请求方法:get
- 响应数据
{
"code": 200,
"message": "信息",
"data": {
"endOrderCount": 6,
"studentCount": 10,
"waitOrderCount": 9,
"workerCount": 6
}
}
请求验证码 👌
- 请求路径:utils/code
- get
- 请求参数
| 参数名 | 参数说明 | 备注 |
|---|---|---|
| uuid | 验证码的key | 不能为空 |
- 响应数据

检查是否存在 👌
- 请求路径:utils/is-exist
- 请求方法:get
- 请求参数
| 参数名 | 参数说明 | 备注 |
|---|---|---|
| id | studentId 或者 workId | 不能为空 |
- 响应数据
{
"code": 200,
"message": "当前用户不存在",
"data": false
}
获取错误类型 👌
- 请求路径:utils/fault-class
- 请求方法:get
- 响应数据
{
"code": 200,
"message": "错误类型列表",
"data": [
]
}