API文档-留言板
当前服务器地址
http://39.108.120.239
主页 项目地址
API系列 API-映射表 API文档-用户部分 API文档-留言板 API文档-微精弘
工程与部署 MySql文档 部署
杂项 &数据(调试用) 第三方提供的API
日志 更新日志
想法&开发者提示 留言板 开发规范
快速查询
留言板
地址
$root/api/msgboard
参数
"method":enum //add,addcomment,update
"credit":string //用户凭证
"id":int? //请求id,int?表示该值可为空
"time":string //时间
"content":string //请求数据
"pic":string //图片数据,要求以16进制字符串传输。
添加留言
当method=
add时跳转到此方法
需要提供的字段:method,credit,content,pic(可选)
样例请求:
url:http://39.108.120.239/api/msgboard
data:method=add&credit=43c1ce34f16240b0ad92e507065e2ac9&content=helloworld
返回状态码及消息:
| code | msg |
|---|---|
| 400 | 无效的请求 |
| 403 | 凭证为空 |
| 403 | 无效的凭证 |
| 403 | 留言内容为空 |
| 200 | 添加留言成功 |
成功返回数据
{
"code": 200,
"msg": "添加成功",
"data": {
"id": 16,
"username": "10086",
"mark":0,
"time": "2019/1/10 9:22:24",
"istop": 0,
"islocked": 0,
"content": "helloworld",
"pic": null,
"comments": []
}
}
添加评论
当method=
addcomment时跳转到此方法
需要提供的字段:method,credit,id,content
id表示被添加的留言的id.
样例请求:
url:http://39.108.120.239/api/msgboard
data:method=addcomment&credit=43c1ce34f16240b0ad92e507065e2ac9&id=1&content=haha
返回状态码及消息:
| code | msg |
|---|---|
| 400 | 无效的请求 |
| 403 | 凭证为空 |
| 403 | 无效的凭证 |
| 403 | 评论内容为空 |
| 200 | 添加评论成功 |
成功返回数据
{
"code": 200,
"msg": "添加评论成功",
"data": {
"id": 2,
"username": "10086",
"mark":0,
"time": "2019/1/8 15:13:04",
"istop": 0,
"islocked": 0,
"content": "helloworld",
"pic": null,
"comments": [{
"id": 1,
"username": "10086",
"time": "2019/1/10 12:50:56",
"content": "haha"
}, {
"id": 2,
"username": "10086",
"time": "2019/1/10 12:51:06",
"content": "haha"
}, {
"id": 3,
"username": "10086",
"time": "2019/1/10 12:51:18",
"content": "haha"
}]
}
}
更新
当method=
update时跳转到此方法
需要提供的字段:method,credit,time
因缓存原因，只在最后200条记录中查询
mark:
time表示最后一次更新的时间，而不是当前的时间。
样例请求:
url:http://39.108.120.239/api/msgboard
data:method=update&credit=43c1ce34f16240b0ad92e507065e2ac9&time=2018/07/07%2014:00:00
返回状态码及消息:
| code | msg |
|---|---|
| 400 | 无效的请求 |
| 403 | 凭证为空 |
| 403 | 无效的凭证 |
| 403 | 时间格式不正确 |
| 200 | 获取留言成功 |
成功返回数据
{
"code": 200,
"msg": "获取留言成功",
"data": {
"time": "2019/1/11 23:41:44",
"content": [{
"id": 3,
"username": "10086",
"time": "2019/1/8 15:13:05",
"mark":0,
"istop": 0,
"islocked": 0,
"content": "helloworld",
"pic": null,
"comments": []
}, {
"id": 2,
"username": "10086",
"mark":0,
"time": "2019/1/8 15:13:04",
"istop": 0,
"islocked": 0,
"content": "helloworld",
"pic": null,
"comments": [{
"id": 1,
"username": "10086",
"time": "2019/1/10 12:50:56",
"content": "haha"
}, {
"id": 2,
"username": "10086",
"time": "2019/1/10 12:51:06",
"content": "haha"
}, {
"id": 3,
"username": "10086",
"time": "2019/1/10 12:51:18",
"content": "haha"
}]
}]
}
}
删除
当method=
delete时跳转到此方法
需要提供的字段:method,credit,id
样例请求
url:http://39.108.120.239/api/msgboard
data:method=delete&credit=43c1ce34f16240b0ad92e507065e2ac9&id=19
mark: 只有爸爸才能够删除儿子的留言，当然，也可以删除自己的留言。
返回状态码及消息:
| code | msg |
|---|---|
| 400 | 无效的请求 |
| 403 | 凭证为空 |
| 403 | 无效的凭证 |
| 403 | 该留言不存在 |
| 403 | 该留言已删除 |
| 200 | 修改留言成功 |
成功返回消息
{
"code":200,
"msg":"删除留言成功"
}
修改留言
当method=
change时跳转到此方法
需要提供的字段:method,credit,id,content,pic(可选)
样例请求
url:http://39.108.120.239/api/msgboard
data:method=change&credit=43c1ce34f16240b0ad92e507065e2ac9&id=19&content=hello
mark: 只有爸爸才能够删除儿子的留言，当然，也可以删除自己的留言。
返回状态码及消息:
| code | msg |
|---|---|
| 400 | 无效的请求 |
| 403 | 凭证为空 |
| 403 | 无效的凭证 |
| 403 | 留言内容为空 |
| 403 | 该留言不存在 |
| 403 | 权限不够 |
| 200 | 修改留言成功 |
成功返回消息
{
"code": 200,
"msg": "修改留言成功",
"data": {
"id": 16,
"username": "10086",
"mark":0,
"time": "2019/1/10 9:22:24",
"istop": 0,
"islocked": 0,
"content": "helloworld",
"pic": null,
"comments": []
}
}
删除评论
当method=
delete时跳转到此方法
需要提供的字段:method,credit,id,subid
样例请求
url:http://39.108.120.239/api/msgboard
data:method=deletecomment&credit=43c1ce34f16240b0ad92e507065e2ac9&id=19&subid=5
mark: 只有爸爸才能够删除儿子的评论，当然，也可以删除自己的评论。
返回状态码及消息:
| code | msg |
|---|---|
| 400 | 无效的请求 |
| 403 | 凭证为空 |
| 403 | 无效的凭证 |
| 403 | 该留言不存在 |
| 403 | 该留言已删除 |
| 200 | 修改留言成功 |
成功返回消息
{
"code":200,
"msg":"删除留言成功"
}