接口文档

2017-12-04  本文已影响42人  水车

平行线接口手册

作者:张泽轩
创建:2017-12-04 @v0.1
修改:****** @v1.0


说明:

1.管理员接口

1.1 登陆

POST: /pxxmanage/home/admin/login/login

请求

{
    name:"",  //用户名
    password:"",  //密码
}

应答

{
    code:n       //状态码, 默认为10000,返回10000,则认为此次请求成功
    errmsg:"",   //错误信息, 可选,如果没有报错,则此字段为空
    user:{
        name:"",  //用户名
        userimg:"", //用户头像
        usertype:""//用户权限大小,例如:超级管理员,前台,财务等等这些状态
    },
    sidebar:[{
        icon: 'el-icon-location',  //图标的名字
        index: '3',                //索引,如果没有子目录,此值为url
        title: 'demo3',            //目录名字
        subs: [{                   //二级目录
            icon: 'el-icon-bell',  //二级目录的图标名字
            index: '3-1',          //索引,如果没有子目录,此值为url
            title: 'demo3-1页面',  //目录名字
            subs: [{              //三级目录
                index: "3-1-1",   //三级目录的索引,此值为url
                title: 'demo3-1-1页面'  //三级目录的名字
            },
            ...
            ]
        },
        ...]
    },
    ...
    ]
    
}

示例

//eg1:正常
{
    code:10000       //状态码, 默认为10000,返回10000,则认为此次请求成功
    errmsg:"",   //错误信息, 可选,如果没有报错,则此字段为空
    user:{
        name:"张泽轩",
        userimg:"boy.jpg", 
        usertype:"超级管理员"
    },
    sidebar:[{
        icon: 'el-icon-date',
        index: '1',
        title: 'demo1',
    },{
        icon: 'el-icon-document',
        index: '2',
        title: 'demo2',
        subs: [{
            icon: 'el-icon-edit',
            index: 'demo21',
            title: 'demo2-1页面',
        }]
    },{
        icon: 'el-icon-location',
        index: '3',
        title: 'demo3',
        subs: [{
            icon: 'el-icon-bell',
            index: '3-1',
            title: 'demo3-1页面',
            subs: [{
                index: "3-1-1",
                title: 'demo3-1-1页面'
            },{
                index: '3-1-2',
                title: 'demo3-1-2页面'
            }]
        }]
    }]
}
//eg2:异常
{
    code:10001      //状态码, 默认为10000,返回10000,则认为此次请求成功
    errmsg:"账号或密码错误",   //错误信息, 可选,如果没有报错,则此字段为空
    user:{},
    sidebar:[]
}

1.2 退出登录接口

POST: /pxxmanage/home/admin/login/logout

请求

{
    name:""  //要退出登录的用户名
}

应答

成功

{
    "code":10000,   // int
    "errmsg":""
}

失败

{
    "code":xxx,  
    "errmsg":"xxxxxxxxxx"
}

1.3 修改密码接口

POST: /pxxmanage/home/admin/login/changepassword

请求

{
    name:""  //要退出登录的用户名
    oldpwd:"" //旧密码
    newpwd:"" //新密码
}

应答

成功

{
    "code":10000,   // int
    "errmsg":""
}

失败

{
    "code":xxx,  
    "errmsg":"xxxxxxxxxx"
}
上一篇 下一篇

猜你喜欢

热点阅读