SPA后台接口文档

1、接口的功能：

获取制定项目的分类信息

2、用户登陆

接口调用请求说明

http请求方式: Post（请使用https协议）
http://localhost:8080/wyy_SSH/vue/userAction_login.action

参数	是否必须	说明
uname	是	登陆时所需要填写的用户名
upwd	是	登陆时所需要填写的用户密码

返回说明
正确时返回JSON数据包：

code: 1
msg: "登录成功"
result: {uname: "zs", pwd: "123"}

参数	说明
code	表示你登陆的状态：0代表登陆失败 1代表登陆成功
msg	登陆时的提示码
result	返回用户所填写的用户名和密码

错误时返回JSON数据包（示例为登陆时用户或者密码错误）：

code: 0
msg: "用户或者密码错误"
result: {uname: "hhh", pwd: "666"}

错误时返回JSON数据包（示例为登陆时用户或者密码为空错误）：

code: 0
msg: "用户或者密码为空"
result: {uname: "", pwd: ""}

3、左侧树形菜单

接口调用请求说明

http请求方式: Post（请使用https协议）
http://localhost:8080/wyy_SSH/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失败

result树形菜单结果集

参数	说明
treeNodeId	菜单id
treeNodeName	菜单名称
treeNodeType	菜单类型 1父菜单 2跳转菜单
url	t跳转的路由地址
icon	菜单图标
children	子菜单集 如果没有,则是一个空的json数组

4、文章管理CRUD

查询文章

http请求方式: Post（请使用https协议）
http://localhost:8080/wyy_SSH/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结果集

参数	说明
id	文章id
title	文章标题
body	文章内容

pageBean分页的属性

参数	说明
page	当前页码
rows	一页展示多少数据
total	共查出多少条数据

增加文章

接口调用请求说明

http请求方式: Post（请使用https协议）
http://localhost:8080/wyy_SSH/vue/articleAction_add.action

参数	是否必须	说明
id	否	文章id 自动增长
title	是	就是所需要填写的文章标题
body	是	就是所需要填写的文章内容

返回说明

添加成功时返回JSON数据包:

{"msg":"新增成功","result":[],"code":1}

添加失败返回JSON数据包：

{"msg":"新增失败","result":[],"code":0}

参数	说明
msg	新增时的提示码
code	状态码：0为失败，1为成功

删除文章

接口调用请求说明

http请求方式: Post（请使用https协议）
http://localhost:8080/wyy_SSH/vue/articleAction_del.action

参数	是否必须	说明
id	是	文章id

返回说明

正确时返回JSON数据包

{"msg":"删除成功","code":1}

错误时返回JSON数据包

{"msg":"删除失败","code":0}

参数	说明
msg	删除时的提示码
code	状态码：0为失败，1为成功

修改文章

接口调用请求说明

http请求方式: Post（请使用https协议）
http://localhost:8080/wyy_SSH/vue/articleAction_edit.action

参数	是否必须	说明
id	是	文章id
title	是	文章标题
body	是	文章内容

返回说明

正确时返回JSON数据包

{"msg":"修改成功","code":1}

错误时返回JSON数据包

{"msg":"修改失败","code":0}

参数	说明
msg	删除时的提示码
code	状态码：0为失败，1为成功

就这样我们就完成了一个后台的接口文档；用什么好的建议可以联系我噢o(=•ェ•=)m