挣闲钱API文档
前端的请求参数为json类型，在请求的header中设置为"Content-Type": "application/json"
用户登录后会获得一个token(令牌)，在前端发送除GET之外的请求时，都需将token赋给Headers的Authorization字段，才有权限对服务端数据进行修改
POST /user/signup
BODY
{
"userId": integer //用户id，注册时不需要赋值，由服务生成，置0即可
"username": string //用户名，必填
"password": string //用户密码，必填
"university": string //用户所在大学，必填
"grade": string //用户所在年级，必填
"phone": string //用户手机号，必填
"major": string //用户所在专业，必填
"email": string //用户邮箱，必填
"balance": integer //用户余额，注册时置0即可
}
参数示例
{
"userId": 0,
"username": "张三",
"password": "123",
"university": "中山大学",
"grade": "大三",
"phone": "13232323233",
"major": "软件工程",
"email": "123456789@qq.com",
"balance": 0
}
返回示例
- 201
{
"userId": 10001,
"username": "张三",
"password": "",
"university": "中山大学",
"grade": "大三",
"phone": "13232323233",
"major": "软件工程",
"email": "123456789@qq.com",
"balance": 0
}
- 400
{
"error": "用户名未填写"
}
POST /user/signin
BODY
{
"userId": integer //用户id，用户注册成功后会返回服务端生成的用户id
"password": string //用户密码
}
参数示例
{
"userId": 10001,
"password": "123",
}
返回示例
- 200
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NjA5NDU4MDksImlhdCI6MTU2MDk0MjIwOX0.M6pDCT4IA0JWhtOLlv6BnejgqwGhxy8AIhLLiM6IxAM"
//由服务端实时生成的token，记录了当前用户的登录状态
//当客户端发送除GET外的请求时，需要将该token赋给Headers的Authorization字段
//以表示有权限对服务端数据进行修改
}
- 400
{
"error": "用户名或密码错误"
}
GET /user/{userId}
Path Parameters
{
"userId": integer //用户id
}
返回示例
- 200
{
"userId": 10001,
"username": "张三",
"password": "",
"university": "中山大学",
"grade": "大三",
"phone": "13232323233",
"major": "软件工程",
"email": "123456789@qq.com",
"balance": 0
}
- 404
{
"error": "用户不存在"
}
DELETE /user/signout
返回示例
-
200
-
400
POST /user/delivery BODY
{
"task":{
"taskId": integer //任务id，由服务端生成，置0即可
"taskType": string //任务类型，必填，分为"questionare"和"delivery"
"taskTitle": string //任务标题，必填
"endTime": string //任务截止日期，必填
"userId": integer //任务发起人id，为当前登录用户
"state": string //任务状态，分为"进行中"和"已完成"，由服务端更新
},
"delivery":{
"deliveryId": integer //快递id，同任务id，由服务端生成，置0即可
"content": string //快递内容
}
}
返回示例
- 200
{
"task":{
"taskId": 10000,
"taskType": "delivery",
"taskTitle": "快递1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
delivery:{
"deliveryId": 10000,
"content": "丰巢2号"
}
}
- 400
{
"error": "发布不成功"
}
POST /user/questionare
BODY
{
"task":{
"taskId": integer //任务id，由服务端生成，置0即可
"taskType": string //任务类型，必填，分为"questionare"和"delivery"
"taskTitle": string //任务标题，必填
"endTime": string //任务截止日期，必填
"userId": integer //任务发起人id，为当前登录用户
"state": string //任务状态，分为"进行中"和"已完成"，由服务端更新
},
questionare:[{
"questionareId": integer //问卷id，同任务id，由服务端生成，置0即可
"num": integer //题目序号，由服务端生成，客户端将问题按顺序存放即可
"title": string //题目内容，必填
"type": string //题目类型，必填，分为"radio"和"checkbox"
"isNeed": string //该题是否必须填写，必填，分为"true"和"false"
"options": string //将题目选项按顺序放置，必填，中间用,隔开
},
...
]
}
参数示例
{
"task":{
"taskId": 0,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 0,
"state": ""
},
questionare:[{
"questionareId": 0,
"num": 0,
"title": "题目1",
"type": "radio",
"isNeed": "true",
"options": "选项1,选项2,选项3"
},
...
]
}
返回示例
- 201
{
"task":{
"taskId": 10000,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
questionare:[{
"questionareId": 10000,
"num": 1,
"title": "题目1",
"type": "radio",
"isNeed": "true",
"options": "选项1,选项2,选项3"
},
{
"questionareId": 10000,
"num": 2,
...
},
...
]
}
- 400
{
"error": "发布不成功"
}
PUT /user/answerBODY
{
"contents":[{
"questionareId": integer //问卷id
"answer": string //题目回答
},
...
]
}
参数示例
{
"contents":[{
"questionareId": 10001, //问卷id
"answer": "1,2" //题目回答
},
...
]
}
返回示例
- 201
{
"contents":[{
"questionareId": 10001,
"answerId": 1, //第x题的回答
"answer": "1,2"
},
{
"questionareId": 10001,
"answerId": 2,
"answer": "1,2"
},
...
]
}
- 400
{
"error": "第x题回答不能为空"
}
PUT /user/publish
BODY
{
"taskId": integer //任务Id
}
参数示例
{
"taskId": 10001
}
返回示例
- 200
- 404
{
"error": "任务不存在"
}
POST /user/task
BODY
{
"taskId": integer
}
返回示例
- 201
{
"taskId": 10004,
"userId": 10005,
"state": "已接取"
}
- 400
{
"error": "任务不存在"
}
PUT /user/accept
BODY
{
"taskId": integer
}
返回示例
- 200
- 400
{
"error": "任务不存在"
}
GET /task/delivery/{taskId}
Path Parameters
{
"taskId": integer
}
返回示例
- 200
{
"task":{
"taskId": 10000,
"taskType": "delivery",
"taskTitle": "快递1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
delivery:{
"deliveryId": 10000,
"content": "丰巢2号"
}
}
- 400
{
"error": "任务不存在"
}
GET /task/questionare/{taskId}
Path Parameters
{
"taskId": integer
}
返回示例
- 200
{
"task":{
"taskId": 10000,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中",
},
questionare:[{
"questionareId": 10000,
"num": 1,
"title": "题目1",
"type": "radio",
"isNeed": "true",
"options": "选项1,选项2,选项3"
},
{
"questionareId": 10000,
"num": 2
...
},
...
]
}
- 400
{
"error": "任务不存在"
}
GET /task/accept?page=&userId=
Query Parameters
{
"page": integer //必填，如果page参数为0，则返回3个任务，供导航页使用；
//如果page大于0，则按页数返回10个任务
"userId": integer //用户id
}
返回示例
- 200
{
"contents":[{
"taskId": 10000,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
...
]
}
- 400
{
"error": "页数超出索引"
}
GET /task/pubish?page=&userId=
Query Parameters
{
"page": integer //必填，如果page参数为0，则返回3个任务，供导航页使用；
//如果page大于0，则按页数返回10个任务
"userId": integer //用户id
}
返回示例
- 200
{
"contents":[{
"taskId": 10000,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
...
]
}
- 400
{
"error": "页数超出索引"
}
GET /task/deliverys?page=&userId=
Query Parameters
{
"page": integer //必填，如果page参数为0，则返回3个任务，供导航页使用；
//如果page大于0，则按页数返回10个任务
"userId": integer //用户id
}
返回示例
- 200
{
"contents":[{
"taskId": 10000,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
...
]
}
- 400
{
"error": "页数超出索引"
}
GET /task/questionares?page=&userId=
Query Parameters
{
"page": integer //必填，如果page参数为0，则返回3个任务，供导航页使用；
//如果page大于0，则按页数返回10个任务
"userId": integer //用户id
}
返回示例
- 200
{
"contents":[{
"taskId": 10000,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
...
]
}
- 400
{
"error": "页数超出索引"
}
GET /task/title?title=&userId=
Query Parameters
{
"title": string //任务标题
"userId": integer //用户id
}
返回示例
- 200
{
"contents":[{
"taskId": 10000,
"taskType": "questionare",
"taskTitle": "问卷1",
"endTime": "2019-06-21",
"userId": 10001,
"state": "进行中"
},
...
]
}
- 400
{
"error": "页数超出索引"
}
GET /task/answer/{questionareId}
Path Parameters
{
"questionareId": integer
}
返回示例
- 200
{
"contents":[{
"questionareId": 10001,
"answerId": 1,
"answer": "1,2"
},
{
"questionareId": 10001,
"answerId": 2,
"answer": "1,2"
},
...
]
}
- 404
{
"error": "问卷不存在"
}