postman接口文档

1. api
   基准路径：http://localhost:8888/api/private/v1/
   除了登录接口，其他所有接口请求头必须设置为Authorization=token (token为登录成功后服务器返回的认证token)
   1.1. 登录
   1.1.1. 登录验证接口
   请求路径：login
   请求方法：post
   请求参数
   参数名 参数说明 备注
   username 用户名 不能为空
   password 密码 不能为空
   响应参数
   参数名 参数说明 备注
   id 用户ID
   rid 用户角色ID
   username 用户名
   mobile 手机号
   email 邮箱
   token 令牌 基于jwt的令牌
   响应数据
   {
   “data”: {
   “id”: 500,
   “rid”: 0,
   “username”: “admin”,
   “mobile”: “123”,
   “email”: "123@qq.com",
   “token”: “Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjUwMCwicmlkIjowLCJpYXQiOjE1MTI1NDQyOTksImV4cCI6MTUxMjYzMDY5OX0.eGrsrvwHm-tPsO9r_pxHIQ5i5L1kX9RX444uwnRGaIM”
   },
   “meta”: {
   “msg”: “登录成功”,
   “status”: 200
   }
   }
   
   1.2. 用户管理
   1.2.1. 用户数据列表
   请求路径：users
   请求方法：get
   请求参数
   参数名 参数说明 备注
   query 查询参数 可以为空
   pagenum 当前页码 不能为空
   pagesize 每页显示条数 不能为空
   响应参数
   参数名 参数说明 备注
   totalpage 总记录数
   pagenum 当前页码
   users 用户数据集合
   响应数据
   {
   “data”: {
   “totalpage”: 5,
   “pagenum”: 4,
   “users”: [
   {
   “id”: 25,
   “username”: “tige117”,
   “mobile”: “18616358651”,
   “type”: 1,
   “openid”: “”,
   “email”: "tige112@163.com",
   “create_time”: “2017-11-09T20:36:26.000Z”,
   “modify_time”: null,
   “is_delete”: false,
   “is_active”: false
   }
   ]
   },
   “meta”: {
   “msg”: “获取成功”,
   “status”: 200
   }
   }
   
   1.2.2. 添加用户
   请求路径：users
   请求方法：post
   请求参数
   参数名 参数说明 备注
   username 用户名称 不能为空
   password 用户密码 不能为空
   email 邮箱 可以为空
   mobile 手机号 可以为空
   响应参数
   参数名 参数说明 备注
   id 用户ID
   rid 用户角色ID
   username 用户名
   mobile 手机号
   email 邮箱
   响应数据
   {
   “data”: {
   “id”: 28,
   “username”: “tige1200”,
   “mobile”: “test”,
   “type”: 1,
   “openid”: “”,
   “email”: "test@test.com",
   “create_time”: “2017-11-10T03:47:13.533Z”,
   “modify_time”: null,
   “is_delete”: false,
   “is_active”: false
   },
   “meta”: {
   “msg”: “用户创建成功”,
   “status”: 201
   }
   }
   
   1.2.3. 修改用户状态
   请求路径：users/:uId/state/:type
   请求方法：put
   请求参数
   参数名 参数说明 备注
   uId 用户ID 不能为空携带在url中
   type 用户状态 不能为空携带在url中，值为true或者false
   响应数据
   {
   “data”: {
   “id”: 566,
   “rid”: 30,
   “username”: “admin”,
   “mobile”: “123456”,
   “email”: "bb@itcast.com",
   “mg_state”: 0
   },
   “meta”: {
   “msg”: “设置状态成功”,
   “status”: 200
   }
   }
   
   1.2.4. 根据ID查询用户信息
   请求路径：users/:id
   请求方法：get
   请求参数
   参数名 参数说明 备注
   id 用户ID 不能为空携带在url中
   响应参数
   参数名 参数说明 备注
   id 用户ID
   role_id 角色ID
   mobile 手机号
   email 邮箱
   响应数据
   {
   “data”: {
   “id”: 503,
   “username”: “admin3”,
   “role_id”: 0,
   “mobile”: “00000”,
   “email”: "new@new.com"
   },
   “meta”: {
   “msg”: “更新成功”,
   “status”: 200
   }
   }
   
   1.2.5. 编辑用户提交
   请求路径：users/:id
   请求方法：put
   请求参数
   参数名 参数说明 备注
   id 用户id 不能为空 参数是url参数:id
   email 邮箱 可以为空
   mobile 手机号 可以为空
   响应参数
   参数名 参数说明 备注
   id 用户ID
   role_id 角色ID
   mobile 手机号
   email 邮箱
   响应数据
   /* 200表示成功，500表示失败 */
   {
   “data”: {
   “id”: 503,
   “username”: “admin3”,
   “role_id”: 0,
   “mobile”: “111”,
   “email”: "123@123.com"
   },
   “meta”: {
   “msg”: “更新成功”,
   “status”: 200
   }
   }
   
   1.2.6. 删除单个用户
   
   请求路径：users/:id
   请求方法：delete
   请求参数
   参数名 参数说明 备注
   id 用户id 不能为空参数是url参数:id
   
   响应参数
   
   
   响应数据
   
   {
   “data”: null,
   “meta”: {
   “msg”: “删除成功”,
   “status”: 200
   }
   }
   
   1.2.7. 分配用户角色
   请求路径：users/:id/role
   请求方法：put
   请求参数
   参数名 参数说明 备注
   id 用户ID 不能为空参数是url参数:id
   rid 角色id 不能为空参数body参数
   响应参数
   参数名 参数说明 备注
   id 用户ID
   role_id 角色ID
   mobile 手机号
   email 邮箱
   响应数据
   {
   “data”: {
   “id”: 508,
   “rid”: “30”,
   “username”: “asdf1”,
   “mobile”: “123123”,
   “email”: "adfsa@qq.com"
   },
   “meta”: {
   “msg”: “设置角色成功”,
   “status”: 200
   }
   }
   
   1.3. 权限管理
   
   1.3.1. 所有权限列表
   
   请求路径：rights/:type
   请求方法：get
   请求参数
   参数名 参数说明 备注
   type 类型 值: list 或 tree , list 列表显示权限, tree 树状显示权限,参数是url参数:type
   响应参数
   参数名 参数说明 备注
   id 权限ID
   authName 权限说明
   level 权限层级
   pid 权限父ID
   path 对应访问路径
   响应数据 type=list
   {
   “data”: [
   {
   “id”: 101,
   “authName”: “商品管理”,
   “level”: “0”,
   “pid”: 0,
   “path”: null
   },
   {
   “id”: 102,
   “authName”: “订单管理”,
   “level”: “0”,
   “pid”: 0,
   “path”: null
   }
   ],
   “meta”: {
   “msg”: “获取权限列表成功”,
   “status”: 200
   }
   }
   type=tree
   [
   {
   “data”: [
   {
   “id”: 101,
   “authName”: “商品管理”,
   “path”: null,
   “pid”: 0,
   “children”: [
   {
   “id”: 104,
   “authName”: “商品列表”,
   “path”: null,
   “pid”: 101,
   “children”: [
   {
   “id”: 105,
   “authName”: