作者 yangfu

用户api 接口

  1 +version: v1
  2 +kind: HttpApi
  3 +metadata:
  4 + service: auth
  5 + path: /auths
  6 + endpoints:
  7 + - method: companySignUp
  8 + route:
  9 + post: /company-sign-up
  10 + - method: phoneAuthCheck
  11 + route:
  12 + post: /phone-auth/check
  13 + - method: phoneAuthResetPassword
  14 + route:
  15 + post: /phone-auth/reset-password
  1 +version: v1
  2 +kind: HttpApi
  3 +metadata:
  4 + service: users
  5 + path: /users
  6 + endpoints:
  7 + - method: updateFavoriteMenus
  8 + route:
  9 + put: /{usersId}/favorite-menus
  10 + - method: getFavoriteMenus
  11 + route:
  12 + get: /{usersId}/favorite-menus
  13 + - method: deleteFavoriteMenus
  14 + route:
  15 + delete: /{usersId}/favorite-menus/{code}
  1 +version: v1
  2 +kind: HttpApi
  3 +metadata:
  4 + service: users
  5 + path: /users
  6 + endpoints:
  7 + - method: createUsers
  8 + route:
  9 + post: /
  10 + - method: updateUsers
  11 + route:
  12 + put: /{usersId}
  13 + - method: getUsers
  14 + route:
  15 + get: /{usersId}
  16 + - method: removeUsers
  17 + route:
  18 + delete: /{usersId}
  19 + - method: listUsers
  20 + route:
  21 + get: /
  22 + params:
  23 + - name: offset
  24 + - name: limit
  25 + - method: getUsersAccessMenus
  26 + route:
  27 + get: /access-menus
  28 + params:
  29 + - name: usersId
  30 + - name: menuCategory
  31 + - method: getUsersBaseInfo
  32 + route:
  33 + get: /base-info
  34 + params:
  35 + - name: usersId
  36 + - name: phone
  37 + - name: usersBaseId
  38 + - method: batchAdd
  39 + route:
  40 + post: /batch-add
  41 + - method: batchEnable
  42 + route:
  43 + post: /batch-enable
  44 + - method: batchResetPassword
  45 + route:
  46 + post: /batch-reset-password
  47 + - method: phoneAuth
  48 + route:
  49 + put: /{usersId}/phone-auth
@@ -4,4 +4,4 @@ metadata: @@ -4,4 +4,4 @@ metadata:
4 name: accessMenus 4 name: accessMenus
5 description: 有权限的菜单 5 description: 有权限的菜单
6 type: 6 type:
7 - primitive: int64 7 + array: int64
@@ -18,7 +18,11 @@ metadata: @@ -18,7 +18,11 @@ metadata:
18 - ref: password 18 - ref: password
19 required: true 19 required: true
20 result: 20 result:
21 - - name: users 21 + - name: code
22 type: 22 type:
23 - schema: users 23 + primitive: int
  24 + required: true
  25 + - name: msg
  26 + type:
  27 + primitive: string
24 required: true 28 required: true
1 version: v1 1 version: v1
2 kind: Method 2 kind: Method
3 metadata: 3 metadata:
4 - name: check 4 + name: phoneAuthCheck
5 type: command 5 type: command
6 - description: 密码检查 6 + description: 手机账号密码检查
7 payload: 7 payload:
8 - ref: phone 8 - ref: phone
9 required: true 9 required: true
1 version: v1 1 version: v1
2 kind: Method 2 kind: Method
3 metadata: 3 metadata:
4 - name: resetPassword 4 + name: phoneAuthResetPassword
5 type: command 5 type: command
6 - description: 重置密码 6 + description: 重置密码(忘记密码)
7 payload: 7 payload:
8 - ref: phone 8 - ref: phone
9 required: true 9 required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: createUsers
  5 + type: command
  6 + description: 创建
  7 + payload:
  8 + - ref: companyId
  9 + required: true
  10 + - ref: usersType
  11 + required: true
  12 + - ref: usersCode
  13 + required: true
  14 + - name: organizationId
  15 + description: 组织机构
  16 + type:
  17 + primitive: int64
  18 + - name: departmentId
  19 + description: 所属部门
  20 + type:
  21 + primitive: int64
  22 + - name: usersOrg
  23 + description: 用户关联的组织
  24 + type:
  25 + array: org
  26 + - name: usersRole
  27 + description: 用户关联的角色
  28 + type:
  29 + array: role
  30 + - name: cooperationInfo
  31 + description: 共创信息 (共创用户有效)
  32 + type:
  33 + schema: cooperationInfo
  34 + - name: enableStatus
  35 + description: 启用状态(启用:1 禁用:2)
  36 + type:
  37 + primitive: int
  38 + result:
  39 + - name: users
  40 + type:
  41 + schema: users
  42 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: deleteFavoriteMenus
  5 + type: command
  6 + description: 移除我收藏的菜单
  7 + payload:
  8 + - ref: code
  9 + required: true
  10 + - ref: usersId
  11 + required: true
  12 + result:
  13 + - name: code
  14 + type:
  15 + primitive: int
  16 + required: true
  17 + - name: msg
  18 + type:
  19 + primitive: string
  20 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: getFavoriteMenus
  5 + type: query
  6 + description: 获取我收藏的菜单
  7 + payload:
  8 + - ref: usersId
  9 + required: true
  10 + result:
  11 + - name: users
  12 + type:
  13 + schema: users
  14 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: getUsers
  5 + type: query
  6 + description: 返回
  7 + payload:
  8 + - ref: usersId
  9 + required: true
  10 + result:
  11 + - name: users
  12 + type:
  13 + schema: users
  14 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: getUsersAccessMenus
  5 + type: query
  6 + description: 返回用户有权限的菜单
  7 + payload:
  8 + - ref: userId
  9 + required: true
  10 + - name: menuCategory
  11 + description: 菜单类别 web app
  12 + required: false
  13 + type:
  14 + primitive: string
  15 + result:
  16 + - name: menus
  17 + type:
  18 + array: menu
  19 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: getUsersBaseInfo
  5 + type: query
  6 + description: 获取用户基础信息数据
  7 + payload:
  8 + - ref: usersId
  9 + required: false
  10 + - ref: phone
  11 + required: false
  12 + - ref: usersBaseId
  13 + required: false
  14 + result:
  15 + - name: users
  16 + type:
  17 + schema: users
  18 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: listUsers
  5 + type: query
  6 + description: 返回列表
  7 + payload:
  8 + - ref: offset
  9 + required: true
  10 + - ref: limit
  11 + required: true
  12 + result:
  13 + - ref: count
  14 + required: true
  15 + - name: userss
  16 + type:
  17 + array: users
  18 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: removeUsers
  5 + type: command
  6 + description: 移除
  7 + payload:
  8 + - ref: usersId
  9 + required: true
  10 + result:
  11 + - name: users
  12 + type:
  13 + schema: users
  14 + required: true
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: updateFavoriteMenus
  5 + type: command
  6 + description: 更新我喜欢菜单列表
  7 + payload:
  8 + - name: favoriteMenus
  9 + description: 菜单编码列表
  10 + type:
  11 + array: string
  12 + - ref: usersId
  13 + required: true
  14 + result:
  15 + - name: code
  16 + type:
  17 + primitive: int
  18 + required: true
  19 + - name: msg
  20 + type:
  21 + primitive: string
  22 + required: true
1 version: v1 1 version: v1
2 kind: Method 2 kind: Method
3 metadata: 3 metadata:
4 - name: phoneAuth 4 + name: updatePhoneAuth
5 type: command 5 type: command
6 - description: 手机认证 6 + description: 手机认证,更新手机号、密码
7 payload: 7 payload:
8 - ref: usersId 8 - ref: usersId
9 required: true 9 required: true
10 - ref: phone 10 - ref: phone
11 - required: true 11 + required: false
12 - ref: password 12 - ref: password
13 - required: true 13 + required: false
14 result: 14 result:
15 - name: code 15 - name: code
16 type: 16 type:
  1 +version: v1
  2 +kind: Method
  3 +metadata:
  4 + name: updateUsers
  5 + type: command
  6 + description: 更新
  7 + payload:
  8 + - ref: usersId
  9 + required: true
  10 + - ref: usersCode
  11 + required: true
  12 + - name: organizationId
  13 + description: 组织机构
  14 + type:
  15 + primitive: int64
  16 + - name: departmentId
  17 + description: 所属部门
  18 + type:
  19 + primitive: int64
  20 + - name: usersOrg
  21 + description: 用户关联的组织
  22 + type:
  23 + array: org
  24 + - name: usersRole
  25 + description: 用户关联的角色
  26 + type:
  27 + array: role
  28 + - name: cooperationInfo
  29 + description: 共创信息 (共创用户有效)
  30 + type:
  31 + schema: cooperationInfo
  32 + - name: enableStatus
  33 + description: 启用状态(启用:1 禁用:2)
  34 + type:
  35 + primitive: int
  36 + result:
  37 + - name: users
  38 + type:
  39 + schema: users
  40 + required: true