发表于： 2020-01-02 22:47:52

1 1074

今天完成的事：

1、账号列表：

简要描述：

  • 账号列表接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/manager/list

请求方式：

  • GET

请求参数：

参数名必选类型说明
pageNumber否number当前页码，默认为1
pageSize否number当前页码显示数，默认为5

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "managers": {
  6.             "pageNum": 1,
  7.             "pageSize": 5,
  8.             "total": 2,
  9.             "pages": 1,
  10.             "list": [
  11.                 {
  12.                     "id": 1,
  13.                     "name": "哈哈",
  14.                     "create_at": 1234567890123,
  15.                     "update_at": 1234567890123,
  16.                     "create_by": "超级管理员",
  17.                     "update_by": "管理员"
  18.                 },
  19.                 {
  20.                     "id": 2,
  21.                     "name": "智孝",
  22.                     "create_at": 1234567890123,
  23.                     "update_at": 1234567890123,
  24.                     "create_by": "超级管理员",
  25.                     "update_by": "管理员"
  26.                 }
  27.             ]
  28.         }
  29.     }
  30.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data数据说明

参数名类型说明
idnumber主键id
namestring账号名称
create_atnumber创建时间
create_bystring创建人
update_atnumber更新时间
update_bystring更新人

2、账号新增（展示角色）：

简要描述：

  • 账号新增接口，将角色展示，新增时选择对应角色

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/manages

请求方式：

  • GET

请求参数：

无

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "roles": [
  6.             {
  7.                 "id": 1,
  8.                 "name": "前台用户管理",
  9.                 "role_msg": "负责前台用户的管理"
  10.             },
  11.             {
  12.                 "id": 2,
  13.                 "name": "课程管理",
  14.                 "role_msg": "负责课程的管理"
  15.             }
  16.         ]
  17.     }
  18.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data参数说明

参数名类型说明
idnumber角色id
namestring角色名称
role_msgstring角色说明

3、账号新增（数据提交）：

简要描述：

  • 账号新增（数据提交）接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/manager

请求方式：

  • POST

请求参数：

参数名必选类型说明
name是string账号名称
password是string密码
create_by是number创建人
role_id否number账号对应角色id

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success"
  4.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

4、账号删除：

简要描述：

  • 账号删除接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/manager/{id}

请求方式：

  • DELETE

请求参数：

参数名必选类型说明
id是number账号id

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success"
  4.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

5、账号编辑（数据回显）：

简要描述：

  • 账号编辑（数据回显）接口，仅可编辑名称、对应角色
  • 账号原有角色是已勾选状态，返回的所有角色，除去原有角色，其他是未有角色

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/manager/{id}

请求方式：

  • GET

请求参数：

参数名必选类型说明
id是number账号id

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "manager": {
  6.             "id": 1,
  7.             "name": "哈哈",
  8.             "roles": [
  9.                 {
  10.                     "id": 1,
  11.                     "name": "前台用户管理",
  12.                     "role_msg": "对前台用户进行管理"
  13.                 }
  14.             ]
  15.         },
  16.         "roles": [
  17.             {
  18.                 "id": 1,
  19.                 "name": "前台用户管理",
  20.                 "role_msg": "负责前台用户的管理"
  21.             },
  22.             {
  23.                 "id": 2,
  24.                 "name": "课程管理",
  25.                 "role_msg": "负责课程的管理"
  26.             }
  27.         ]
  28.     }
  29.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data数据说明

参数名类型说明
idnumber主键id
namestring账号名称
rolesobject账号对应角色信息

role数据说明

参数名类型说明
idnumber主键id
namestring角色名称
role_msgstring角色说明

6、账号编辑（数据提交）：

简要描述：

  • 账号编辑（数据提交）接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/manager/{id}

请求方式：

  • PUT

请求参数：

参数名必选类型说明
id是number账号id
update_by是string编辑人

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success"
  4.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

7、账号查询：

简要描述：

  • 账号查询接口，根据名称模糊查询

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/manager/search

请求方式：

  • GET

请求参数：

参数名必选类型说明
name是string账号名称
pageNumber否number当前页码，默认为1
pageSize否number当前页码显示数，默认为5

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "managers": {
  6.             "pageNum": 1,
  7.             "pageSize": 5,
  8.             "total": 2,
  9.             "pages": 1,
  10.             "list": [
  11.                 {
  12.                     "id": 1,
  13.                     "name": "哈哈",
  14.                     "create_at": 1234567890123,
  15.                     "update_at": 1234567890123,
  16.                     "create_by": "超级管理员",
  17.                     "update_by": "管理员"
  18.                 },
  19.                 {
  20.                     "id": 2,
  21.                     "name": "智孝",
  22.                     "create_at": 1234567890123,
  23.                     "update_at": 1234567890123,
  24.                     "create_by": "超级管理员",
  25.                     "update_by": "管理员"
  26.                 }
  27.             ]
  28.         }
  29.     }
  30.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data数据说明

参数名类型说明
idnumber主键id
namestring账号名称
create_atnumber创建时间
create_bystring创建人
update_atnumber更新时间
update_bystring更新人

2、角色列表：

简要描述：

  • 角色列表接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/role/list

请求方式：

  • GET

请求参数：

参数名必选类型说明
pageNumber否number当前页码，默认为1
pageSize否number当前页码显示数，默认为5

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "roles": {
  6.             "pageNum": 1,
  7.             "pageSize": 5,
  8.             "total": 2,
  9.             "pages": 1,
  10.             "list": [
  11.                 {
  12.                     "id": 1,
  13.                     "name": "前台用户管理",
  14.                     "role_msg": "负责前台用户的管理",
  15.                     "create_at": 1234567890123,
  16.                     "update_at": 1234567890123,
  17.                     "create_by": "超级管理员",
  18.                     "update_by": "超级管理员"
  19.                 },
  20.                 {
  21.                     "id": 2,
  22.                     "name": "课程管理",
  23.                     "role_msg": "负责课程的管理",
  24.                     "create_at": 1234567890123,
  25.                     "update_at": 1234567890123,
  26.                     "create_by": "超级管理员",
  27.                     "update_by": "超级管理员"
  28.                 }
  29.             ]
  30.         }
  31.     }
  32.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data数据说明

参数名类型说明
idnumber主键id
namestring角色名称
role_msgstring角色说明
create_atnumber创建时间
create_bystring创建人
update_atnumber更新时间
update_bystring更新人

2、角色新增（展示权限）：

简要描述：

  • 角色新增接口，将权限展示，新增时选择对应权限

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/role

请求方式：

  • GET

请求参数：

无

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "permissions": [
  6.             {
  7.                 "id": 1,
  8.                 "name": "前台用户管理权限",
  9.                 "per_msg": "负责前台用户的管理权限"
  10.             },
  11.             {
  12.                 "id": 2,
  13.                 "name": "课程管理权限",
  14.                 "per_msg": "负责课程的管理权限"
  15.             }
  16.         ]
  17.     }
  18.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data参数说明

参数名类型说明
idnumber权限id
namestring权限名称
per_msgstring权限说明

3、角色新增（数据提交）：

简要描述：

  • 角色新增（数据提交）接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/role

请求方式：

  • POST

请求参数：

参数名必选类型说明
name是string角色名称
role_msg是string角色说明
create_by是number创建人
permission_id否number角色对应权限id

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success"
  4.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

4、角色删除：

简要描述：

  • 角色删除接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/role/{id}

请求方式：

  • DELETE

请求参数：

参数名必选类型说明
id是number角色id

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success"
  4.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

5、角色编辑（数据回显）：

简要描述：

  • 角色编辑（数据回显）接口，仅可编辑名称、对应权限
  • 角色原有权限是已勾选状态，返回的所有权限，除去原有权限，其他是未有权限

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/role/{id}

请求方式：

  • GET

请求参数：

参数名必选类型说明
id是number角色id

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success",
  4.     "data": {
  5.         "role": {
  6.             "id": 1,
  7.             "name": "前台用户管理",
  8.             "permissions": [
  9.                 {
  10.                     "id": 1,
  11.                     "name": "前台用户管理权限",
  12.                     "per_msg": "对前台用户进行管理的权限"
  13.                 }
  14.             ]
  15.         },
  16.         "permissions": [
  17.             {
  18.                 "id": 1,
  19.                 "name": "前台用户管理权限",
  20.                 "per_msg": "负责前台用户管理的权限"
  21.             },
  22.             {
  23.                 "id": 2,
  24.                 "name": "课程管理的权限",
  25.                 "per_msg": "负责课程管理的权限"
  26.             }
  27.         ]
  28.     }
  29.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息
dataobject数据信息

data数据说明

参数名类型说明
idnumber主键id
namestring角色名称
permissionsobject角色对应权限信息

permission数据说明

参数名类型说明
idnumber主键id
namestring权限名称
per_msgstring权限说明

6、角色编辑（数据提交）：

简要描述：

  • 角色编辑（数据提交）接口

请求URL：

  • dev.admin.daoxiangzhe.xiuzhenyuan.cn/a/u/role/{id}

请求方式：

  • PUT

请求参数：

参数名必选类型说明
id是number角色id
update_by是string编辑人

返回示例

  1.   {
  2.     "code": 200,
  3.     "msg": "success"
  4.   }

返回参数说明

参数名类型说明
codenumber状态码
msgstring状态信息

明天计划的事：

1、继续编写接口文档、设计数据表。
遇到的问题：
写着写着又想到问题，再回去改，反复几次，还需理清思路。
收获：
对接口文档的考虑稍微加深些。
上一篇
返回列表 返回列表
下一篇
现在开始，找个师兄带你入门
评论

    分享到

    技能树  |  IT修真院

    关于我们 ｜ 联系我们 ｜ 合作公司

    移动端下载

    友情链接

    短信验证码     

    微信公众平台

    Copyright © 2015 北京葡萄藤信息技术有限公司 All Rights Reserved | 京ICP备15035574号-1