接口文档示例
程序员文章站
2022-03-15 17:31:20
...
用户登录注册
登录
http请求方式: POST(请使用https协议)
https://localhost:8080/hu/vue/userAction_login.action
参数 | 是否必须 | 说明 |
---|---|---|
uname | 是 | 用户名 |
upwd | 是 | 密码 |
登录成功返回JSON数据包:
{
"msg":"登录成功",
"result":{
"uname":"你登录的用户名",
"pwd":"你登录的密码"
},
"code":1
}
如果登录成功code返回1,否则返回0,msg是提示信息
说明:
参数 | 说明 |
---|---|
msg | 提示信息 |
result | 登录的用户名和密码 |
code | 登录时的状态:1成功,0失败 |
注册
注册返回JSON数据包:
{
"msg":"用户注册成功",
"code":1
}
说明:
参数 | 说明 |
---|---|
msg | 提示信息 |
code | 注册状态:1成功,0失败 |
树形菜单
http请求方式: GET(请使用https协议)
https://localhost:8080/hu/vue/treeNodeAction.action
返回的json数据表如下:
{
"msg": "操作成功",
"result": [
{
"treeNodeId": 1,
"treeNodeName": "系统管理",
"treeNodeType": 1,
"url": null,
"position": 1,
"icon": "el-icon-setting",
"children": [
{
"treeNodeId": 2,
"treeNodeName": "用户管理",
"treeNodeType": 2,
"url": "/sys/VuexPage1",
"position": 2,
"icon": "el-icon-user",
"children": []
},
{
"treeNodeId": 3,
"treeNodeName": "角色管理",
"treeNodeType": 2,
"url": "/sys/VuexPage2",
"position": 3,
"icon": "",
"children": []
},
{
"treeNodeId": 4,
"treeNodeName": "密码修改",
"treeNodeType": 2,
"url": null,
"position": 4,
"icon": null,
"children": []
}
]
},
{
"treeNodeId": 5,
"treeNodeName": "论坛管理",
"treeNodeType": 1,
"url": null,
"position": 5,
"icon": "el-icon-reading",
"children": [
{
"treeNodeId": 6,
"treeNodeName": "文章管理",
"treeNodeType": 2,
"url": "/sys/Articles",
"position": 6,
"icon": null,
"children": []
}
]
}
],
"code": 1
}
说明:
参数 | 说明 |
---|---|
msg | 消息提示 |
result | 结果集 |
code | 状态:1成功,2失败 |
增删查改
查
http请求方式: POST(请使用https协议)
http://localhost:8080/hu/vue/articleAction_list.action
参数 | 是否必须 | 说明 |
---|---|---|
page | 否 | 页数:默认是1 |
rows | 否 | 行数:默认是10 |
title | 否 | 查询条件 |
正确时返回JSON数据包:
{
"result":[{"id":1,"title":"vue教程","body":"vue是一个很牛逼的框架"],
"pageBean":{
"page":2,
"rows":1,
"total":0,
}
}
result结果集
参数 | 说明 |
---|---|
title | 文章标题 |
body | 文章内容 |
ID | 文章ID |
pageBean
参数 | 说明 |
---|---|
page | 页数 |
rows | 每页的数量 |
total | 总条数 |
增
http请求方式: POST(请使用https协议)
http://localhost:8080/hu/vue/articleAction_add.action
参数 | 是否必须 | 说明 |
---|---|---|
ID | 否 | 文章ID |
title | 是 | 文章标题 |
body | 是 | 文章内容 |
正确时返回JSON数据包:
{"msg":"新增成功","result":[],"code":1}
参数 | 说明 |
---|---|
msg | 消息提示 |
code | 状态:1成功,0失败 |
删
http请求方式: POST(请使用https协议)
http://localhost:8080/hu/vue/articleAction_del.action
参数 | 是否必须 | 说明 |
---|---|---|
ID | 是 | 文章ID |
正确时返回JSON数据包:
{"msg":"删除成功","code":1}
参数 | 说明 |
---|---|
msg | 消息提示 |
code | 状态:1成功,0失败 |
改
http请求方式: POST(请使用https协议)
http://localhost:8080/hu/vue/articleAction_edit.action
参数 | 是否必须 | 说明 |
---|---|---|
ID | 是 | 文章ID |
title | 是 | 文章标题 |
body | 是 | 文章内容 |
正确时返回JSON数据包:
{"msg":"修改成功","code":1}
参数 | 说明 |
---|---|
msg | 消息提示 |
code | 状态:1成功,0失败 |