【SPA项目接口文档】

前言

如上所述，本文档是SPA项目的一个接口文档，因为前后端的交互就在于此。

---

用户登录

因为我是用的本地的，而且项目名为sshdemo
接口调用请求说明

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

参数	是否必须	参数说明
uname	必须	用户名
pwd	必须	用户密码

返回说明

正确时返回JSON数据包：

第一种：登录成功

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

第二种：登录失败

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

第三种: 用户名或密码为空

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

参数	说明
code	状态码：0为失败，1为成功
msg	消息提示
result	返回发出的所有信息

---

树形菜单

接口调用请求说明

http请求方式: POST（请使用https协议）
http://localhost:8080/sshdemo/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
}

这个一般不会出错的

参数	说明
code	状态码：0为失败，1为成功
msg	消息提示
result	查询树形菜单后返回的集合

---

数据表格的crud

查询文章

接口调用请求说明

http请求方式: POST（请使用https协议）
http://localhost:8080/sshdemo/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/sshdemo/vue/articleAction_add.action

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

返回说明

一，正确时返回JSON数据包

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

二，错误时返回JSON数据包

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

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

---

修改文章

接口调用请求说明

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

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

返回说明

一，正确时返回JSON数据包

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

二，错误时返回JSON数据包

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

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

---

文章删除

接口调用请求说明

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

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

返回说明

一，正确时返回JSON数据包

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

二，错误时返回JSON数据包

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

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

---

总结

这就是暂时的一个之前所有写好的vue前端交于后端的一个接口文档。

Thanks♪(･ω･)ﾉ希望对大家有所帮助