教你怎么写后台接口文档

用户登陆

http请求方式: POST

https://xxx.xxx.xxx:8080/项目命名/vue/userAction_login.action

参数	是否必须	说明
Name	是	用户名
Pwd	是	密码

登录成功返回json数据：

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

登录失败返回json数据：

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

参数	说明
code	状态码 1登录成功 0登录失败
msg	提示消息
result	返回的登录名和密码

用户注册

http请求方式: POST

https://xxx.xxx.xxx:8080/项目命名vue/userAction_reg.action

参数	是否必须	说明
uname	是	注册名
pwd	是	密码

注册成功返回json数据：

1.  code: 1
2.  msg: "注册成功"

注册失败返回json数据：

1.  code: 0
2.  msg: "注册失败"

参数	说明
code	状态 1.注册成功 2.注册失败
msg	提示信息

左侧树形菜单加载

http请求方式: POST
https://xxx.xxx.xxx:8080/项目命名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	路由地址
position	位置
icon	菜单图标
children	子菜单集，如果没有则为一个空json数组

文章查询

http请求方式: POST
https://xxx.xxx.xxx:8080/项目命名vue/articleAction_list.action

参数	是否必须	说明
page	否	当前页码，默认为1
rows	否	一页展示多少条数据，默认为10
title	否	如果有就按照文章标题进行模糊查询，如果没有此参数就查询所有

返回json数据包说明：

{
	"result":[{"id":15,"title":"solr简介","body":"solr简单了解下，相较于lucene好处在哪里"],
	"pageBean":{
		"page":2,
		"rows":1,
		"total":0,
	}
}

result结果集说明

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

pageBean 结果说明

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

文章新增

http请求方式: POST
https://xxx.xxx.xxx:8080/项目命名vue/articleAction_add.action

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

返回json数据包说明
新增成功

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

新增失败

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

参数	说明
msg	提示信息
code	状态码 1成功 0失败

文章修改

http请求方式: POST
https://xxx.xxx.xxx:8080/项目命名vue/articleAction_edit.action

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

返回json数据包说明
修改成功

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

修改失败

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

参数	说明
msg	提示消息
code	状态码 1成功 0失败

文章删除

http请求方式: POST
https://xxx.xxx.xxx:8080/项目命名vue/articleAction_del.action

参数	是否必须	说明
id	是	删除的id

返回json数据包说明

删除成功

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

删除失败

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

参数	说明
msg	提示消息
code	状态码 1成功 0失败