美文网首页
接口文档

接口文档

作者: 水车 | 来源:发表于2017-12-04 21:40 被阅读42次

平行线接口手册

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


说明:

  • 接口名命名规则: /项目名/模块名/事件类型/函数名

1.管理员接口

1.1 登陆

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

  • 该接口用于管理员登陆系统

请求

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

应答

  • 应答为JSON
{
    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:""  //要退出登录的用户名
}

应答

  • 应答json格式

成功

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

失败

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

1.3 修改密码接口

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

  • 该接口为修改密码接口

请求

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

应答

  • 应答json格式

成功

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

失败

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

相关文章

  • Vue应用框架整合与实战--前后端分离后的开发模式篇

    开发流程 后台编写和维护接口文档,在 API 变化时更新接口文档 后台根据接口文档进行接口开发 前端根据接口文档进...

  • 接码平台汇总

    短租接口文档 火云接口文档 火云官网 神话接口文档

  • 接口测试--接口文档规范

    接口测试的依据,往往不是需求文档,而是接口文档。 那么,接口文档的准确性便至关重要,本文推荐apipost接口文档...

  • 谈谈单接口测试

    如果只是单个接口的测试还是归属于功能测试。 平时我们是怎么做接口测试的?接口文档、接口文档,一定要看接口文档。初学...

  • 工作总结 文章目录

    工作总结 文章目录 狼人杀拾旧后台接口文档 狼人杀俱乐部后台接口文档 狼人杀接口文档 OA使用文档(报表,人事) ...

  • drf框架接口文档

    drf框架接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接...

  • 接口文档工具 apiPost

    ApiPost = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试。 生成Mock...

  • 接口文档

    接口文档 1.登录 请求地址:/account/login请求方式:post 成功示例:{"ok":1,"data...

  • 接口文档

    第6节(判断数据库中是否有此用户) post www.test.com/api api.test.com

  • 接口文档

    1.获取铁甲云盒项目实时视频的API链接 接口地址: http:xxx:9998/tools/app_api.as...

网友评论

      本文标题:接口文档

      本文链接:https://www.haomeiwen.com/subject/kfufixtx.html