欢迎加入我们~
车轴探伤检测
所有接口的回参都是在下述结构的基础上修改的:
{
code: 400, # 200(成功), 400, 500
msg: '数据库错误', # 描述信息,如果code为200,则msg无意义
data: {
user: {...}
...
}
}
# user 内部结构
{
id: 1,
username: "adadaa",
password: "123456", # 密码6位以上
user_type: 200, # 100(管理员), 200(普通用户), 300(测试用户)
}
# message 内部结构
{
id: 1,
title: "标题",
type: 2, # 1(紧急通知), 2(自动告警), 3(普通通知)
content: "内容",
is_read: true,
created_at: "2020-01-01 12:00:00"
updated_at: "2020-01-01 12:00:00"
}
以下所有,除非特别说明,否则都需要token。 token字段填充在Headers中。
验证码模块不需要token
## 入参
GET /captcha
## 回参
{
"code": 200,
"msg": "success",
"data": {
"captcha_id": "xhNoTT2PjOaYLPBm2P45",
"image_url": "/captcha/xhNoTT2PjOaYLPBm2P45.png"
}
}
## 入参
POST /captcha
# 在Body中
{
captcha_id: "xhNoTT2PjOaYLPBm2P45"
captcha_solution: "123456"
}
## 回参
{
"code": 400,
"msg": "验证码错误",
"data": null
}
## 入参
GET /captcha/:filename # filename = captcha_id + ".png"
## 回参
# 返回一张图片
登录接口不需要token
## 入参
POST /login
# 在Body中
{
captcha_id: "xhNoTT2PjOaYLPBm2P45"
captcha_solution: "123456"
username: "admin"
password: "123456"
user_type: 200
}
## 回参
{
"code": 200,
"msg": "success",
"data": {
"token": "eyJhJ9.ewLCJ2MDl9.hd2vnggDY"
}
}
## 入参
PUT /user
# 在Body中
{ # user结构,除了id }
## 回参
{
"code": 200,
"msg": "success",
"data": {
"id": 146
}
}
## 入参
POST /user
# 在Body中
{ # user结构 }
## 回参
{
"code": 200,
"msg": "success",
"data": null
}
## 入参
DELETE /user
# 在Params中
{
id: 146
}
## 回参
{
"code": 200,
"msg": "success",
"data": null
}
## 入参
GET /user/:id
## 回参
{
"code": 200,
"msg": "success",
"data": {
"user": { # user结构,除了密码 }
}
}
## 入参
GET /user
# 在Params中
{
"page": 1,
"page_size": 20,
"key": "admin" # 关键词搜索(只接受单个关键词)
}
## 回参
{
"code": 200,
"msg": "success",
"data": {
"total": 146,
"users": {
{ # user结构,除了密码 }
{ # user结构,除了密码 }
{ # user结构,除了密码 }
}
}
}
## 入参
PUT /message
# 在Body中
{ # message结构,除了id、时间 }
## 回参
{
"code": 200,
"msg": "success",
"data": {
"id": 146
}
}
## 入参
POST /message
# 在Body中
{ # message结构,除了时间 }
## 回参
{
"code": 200,
"msg": "success",
"data": null
}
## 入参
DELETE /message
# 在Query中
{
"id": 146
}
## 回参
{
"code": 200,
"msg": "success",
"data": null
}
## 入参
GET /message
## 回参
{
"code": 200,
"msg": "success",
"data": {
"total": 23,
"messages": { # 按更新时间排序
{ # message结构 }
{ # message结构 }
{ # message结构 }
}
}
}
## 入参
GET /message/:id
## 回参
{
"code": 200,
"msg": "success",
"data": {
"message": { # message结构 }
}
}
## 入参
POST /message/read
# 在Body中
{ id: 1 }
## 回参
{
"code": 200,
"msg": "success",
"data": null
}
## 入参
POST /message/reads
## 回参
{
"code": 200,
"msg": "success",
"data": null
}
## 入参
POST /image
# 在Body中
{
"file": { #file结构 } #<15MB
}
## 回参
{
"code": 200,
"msg": "success",
"data": {
"id": "ndCian82hBzdOmca" #16位识别码
}
}
## 入参
GET /image/:id
## 回参
{
"code": 200,
"msg": "success",
"data": {
"ext": "jpg"
"image": "图片编码"
}
}
## 入参
POST /image/info
# 在Body中
{
{
"vehicle_id": "" #车辆id,字符类型(暂定)
"carriage_id": "" #车厢id,字符类型(暂定)
"axle_id": "" #车轴id,字符类型(暂定)非空
"image_id": "ndCian82hBzdOmca" #图片识别码 非空
}
{
"vehicle_id": "" #车辆id,字符类型(暂定)
"carriage_id": "" #车厢id,字符类型(暂定)
"axle_id": "" #车轴id,字符类型(暂定)非空
"image_id": "ndCian82hBzdOmca" #图片识别码 非空
}
{
"vehicle_id": "" #车辆id,字符类型(暂定)
"carriage_id": "" #车厢id,字符类型(暂定)
"axle_id": "" #车轴id,字符类型(暂定)非空
"image_id": "ndCian82hBzdOmca" #图片识别码 非空
}
}
## 回参
{
"code": 200,
"msg": "success",
"data": null
}