SPA项目开发之后台接口文档

• 用户登录
• 用户注册
• 文章curd

一、用户登录

调用接口说明：

 

https://localhost:8080/项目名/vue/userAction_login.action

 

 

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

正确时返回JSON数据包：

{
    "code":1
    "msg":"登录成功",
    "result":{
        "uname":"用户名",
        "pwd":"密码"
    }
}

为空时返回JSON数据包：

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

失败时返回JSON数据包：

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

 

参数	说明
msg	提示信息
Result	返回登录时候的用户名和密码
Code	状态 1.登录成功  2.登录失败

二、用户注册

调用接口说明：

 

http://www.xxx.xxx:8080/项目名/vue/userAction_add.action

 

 

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

 

成功时返回JSON数据：

 

{
    "msg":"注册成功",
    "code":1
}

 

失败时返回JSON数据：

{
    "msg":"注册失败",
    "code":0
}

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

 

 

 

三、文章的crud

文章新增：

 

http: //www.xxx.xxx:8080/项目名/vue/articleAction_add.action

 

参数	说明
Title	文章标题
body	文章内容

 

 

 

成功时返回JSON数据：

 

{
    "msg":"增加成功",
    "code":1
}

 

 

失败时返回JSON数据：

 

{
    "msg":"增加失败",
    "code":0
}

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

文章删除：

http: //www.xxx.xxx:8080/项目名/vue/articleAction_del.action

 

 

 

参数	是否必须	说明
Id	是	要删除的文章id

成功时返回JSON数据：

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

失败时返回JSON数据：

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

 

 

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

 

文章修改：

http: //www.xxx.xxx:8080/项目名/vue/articleAction_edit.action

 

参数	是否必须	说明
Id	是	要修改的id
body	否	文章内容
Title	是	文章标题

 

成功时返回JSON数据：

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

 

失败时返回JSON数据：

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

 

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

 

文章查询：

url: " http: //www.xxx.xxx:8080/项目名/vue/articleAction_list.action

 

参数	说明
Maxpage	最大页码
Page	当前页码，默认为1
Rows	一页多少条数据
total	总共多少条数据

 

返回JSON数据：

{
    "result":[{"id": 0,"title":"vue","body":"vue"],
    "pageBean":{
        "page":1,
        "MaxPage": 10,
        "rows":1,
        "total":0,
    }
}

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