后台接口文档示例

什么是接口文档？

在项目期间，前后端是分离开发的，为了前后有连贯性，就必须由前后开发工程师共同定义接口、写接口文档再根据接口文档去开发，一直到项目结束。

接口文档规范

• 方法

　　也就是我们常写的新增，删除，修改，查询

• url

　　调用方法，一般是从前端调后端的方法地址

• 请求参数

　　一般分五列：字段、说明、类型、备注、是否必填 

• 返回参数

　　1、如果只返回接口调用成功还是失败（新增、删除、修改等），则只有一个结构体：

　　　　　　code和message两个参数；

　　2、如果要返回某些参数，则有两个结构体：

　　　　　　是code/mesage/data；

　　　　　   是data里写返回的参数,data是object类型；

　　3、如果要返回列表，那么有三个结构体，

　　     　　 是code/mesage/data,data是object，里面放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list里放object，object里是具体的参数。

了解目的

1. 用户登录
2. 用户注册
3. 树形菜单
4. 文章查询
5. 文章新增
6. 文章修改
7. 文章删除

用户登录：

　　接口调用and请求

http请求方式: POST    （一般有两种get/post）
https://xxx.xxx.xxx:8080/项目命名/vue/userAction_login.action

字段	说明	类型	是否必填
uname	名字	String	是
pwd	密码	String	是

登录成功返回JSON数据包:

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

用户或者密码为空返回JSON数据包:

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

用户或者密码错误返回JSON数据包:

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