新增sample-user的接口规范文档
diff --git "a/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/sample-user.yaml" "b/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/sample-user.yaml"
new file mode 100644
index 0000000..3fbe5db
--- /dev/null
+++ "b/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/sample-user.yaml"
@@ -0,0 +1,1366 @@
+openapi: 3.0.0
+info:
+ version: 1.0.0
+ title: Sample User
+servers:
+ - url: 'http://localhost:10010/api/v1'
+paths:
+ '/admin/users':
+ get:
+ summary: 查询用户
+ operationId: admin-users-list
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[username]'
+ in: query
+ description: 查询条件-用户名
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[name]'
+ in: query
+ description: 查询条件-姓名
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[status]'
+ in: query
+ description: 查询条件-状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 用户列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserPager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 创建用户
+ operationId: admin-users-create
+ tags:
+ - Api1AdminUserController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ test1:
+ value: {
+ "companyId": "1",
+ "deleted": false,
+ "addAccount": "admin",
+ "username": "test1",
+ "password": "test1",
+ "enabled": true,
+ "accountNonExpired": true,
+ "accountNonLocked": true,
+ "credentialsNonExpired": true,
+ "name": "测试1",
+ "status": "1",
+ }
+ responses:
+ '200':
+ description: 创建成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.create.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ put:
+ summary: 修改用户
+ operationId: admin-users-update
+ tags:
+ - Api1AdminUserController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ test1:
+ value: {
+ "id": "1",
+ "status": "0"
+ }
+ responses:
+ '200':
+ description: 修改成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.update.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/users/{id}':
+ get:
+ summary: 根据ID获取用户
+ operationId: admin-users-get
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ delete:
+ summary: 根据ID删除用户
+ operationId: admin-users-delete
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.delete.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/users/{id}/groups':
+ get:
+ summary: 根据ID获取用户的关联用户组
+ operationId: admin-users-userGroups
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[groupCode]'
+ in: query
+ description: 查询条件-用户组代码
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[groupName]'
+ in: query
+ description: 查询条件-用户组名称
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[groupStatus]'
+ in: query
+ description: 查询条件-用户组状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 用户的关联用户组列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupUserPager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 关联用户的用户组
+ operationId: admin-users-relateGroups
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupUsers'
+ responses:
+ '200':
+ description: 设置成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {
+ "success": "info.set.success"
+ }
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/users/{id}/roles':
+ get:
+ summary: 根据ID获取用户的关联角色
+ operationId: admin-users-userRoles
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[roleCode]'
+ in: query
+ description: 查询条件-角色代码
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[roleName]'
+ in: query
+ description: 查询条件-角色名称
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[roleStatus]'
+ in: query
+ description: 查询条件-角色状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 用户的关联角色列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserRolePager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 关联用户的角色
+ operationId: admin-users-relateRoles
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserRoles'
+ responses:
+ '200':
+ description: 设置成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {
+ "success": "info.set.success"
+ }
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/groups':
+ get:
+ summary: 查询用户组
+ operationId: admin-groups-list
+ tags:
+ - Api1AdminGroupController
+ parameters:
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[code]'
+ in: query
+ description: 查询条件-代码
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[name]'
+ in: query
+ description: 查询条件-名称
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[status]'
+ in: query
+ description: 查询条件-状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 用户组列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupPager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 创建用户组
+ operationId: admin-groups-create
+ tags:
+ - Api1AdminGroupController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Group'
+ examples:
+ test1:
+ value: {
+ "companyId": "1",
+ "deleted": false,
+ "addAccount": "admin",
+ "code": "group1",
+ "name": "测试组1",
+ "memo": "",
+ "status": "1"
+ }
+ responses:
+ '200':
+ description: 创建成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.create.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ put:
+ summary: 修改用户组
+ operationId: admin-groups-update
+ tags:
+ - Api1AdminGroupController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Group'
+ examples:
+ test1:
+ value: {
+ "id": "1",
+ "status": "0"
+ }
+ responses:
+ '200':
+ description: 修改成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.update.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/groups/{id}':
+ get:
+ summary: 根据ID获取用户组
+ operationId: admin-groups-get
+ tags:
+ - Api1AdminGroupController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户组ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Group'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ delete:
+ summary: 根据ID删除用户组
+ operationId: admin-groups-delete
+ tags:
+ - Api1AdminGroupController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户组ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.delete.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/groups/{id}/users':
+ get:
+ summary: 根据ID获取用户组的关联用户
+ operationId: admin-groups-groupUsers
+ tags:
+ - Api1AdminGroupController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[userUsername]'
+ in: query
+ description: 查询条件-用户名
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[userName]'
+ in: query
+ description: 查询条件-用户姓名
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[userStatus]'
+ in: query
+ description: 查询条件-用户状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 用户组的关联用户列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupUserPager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 关联用户组的用户
+ operationId: admin-groups-relateUsers
+ tags:
+ - Api1AdminGroupController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupUsers'
+ responses:
+ '200':
+ description: 设置成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {
+ "success": "info.set.success"
+ }
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/groups/{id}/roles':
+ get:
+ summary: 根据ID获取用户组的关联角色
+ operationId: admin-groups-groupRoles
+ tags:
+ - Api1AdminGroupController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[roleCode]'
+ in: query
+ description: 查询条件-角色代码
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[roleName]'
+ in: query
+ description: 查询条件-角色名称
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[roleStatus]'
+ in: query
+ description: 查询条件-角色状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 用户组的关联角色列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupRolePager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 关联用户组的角色
+ operationId: admin-groups-relateRoles
+ tags:
+ - Api1AdminGroupController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupRoles'
+ responses:
+ '200':
+ description: 设置成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {
+ "success": "info.set.success"
+ }
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/roles':
+ get:
+ summary: 查询角色
+ operationId: admin-roles-list
+ tags:
+ - Api1AdminRoleController
+ parameters:
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[code]'
+ in: query
+ description: 查询条件-代码
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[name]'
+ in: query
+ description: 查询条件-名称
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[status]'
+ in: query
+ description: 查询条件-状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 角色列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RolePager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 创建角色
+ operationId: admin-roles-create
+ tags:
+ - Api1AdminRoleController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Role'
+ examples:
+ test1:
+ value: {
+ "companyId": "1",
+ "deleted": false,
+ "addAccount": "admin",
+ "code": "role1",
+ "name": "测试角色1",
+ "memo": "",
+ "status": "1"
+ }
+ responses:
+ '200':
+ description: 创建成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.create.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ put:
+ summary: 修改角色
+ operationId: admin-roles-update
+ tags:
+ - Api1AdminRoleController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Role'
+ examples:
+ test1:
+ value: {
+ "id": "1",
+ "status": "0"
+ }
+ responses:
+ '200':
+ description: 修改成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.update.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/roles/{id}':
+ get:
+ summary: 根据ID获取角色
+ operationId: admin-roles-get
+ tags:
+ - Api1AdminRoleController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 角色ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Role'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ delete:
+ summary: 根据ID删除角色
+ operationId: admin-roles-delete
+ tags:
+ - Api1AdminRoleController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 角色ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value:
+ success: info.delete.success
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/roles/{id}/users':
+ get:
+ summary: 根据ID获取角色的关联用户
+ operationId: admin-roles-roleUsers
+ tags:
+ - Api1AdminRoleController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 角色ID
+ schema:
+ type: string
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[userUsername]'
+ in: query
+ description: 查询条件-用户名
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[userName]'
+ in: query
+ description: 查询条件-用户姓名
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[userStatus]'
+ in: query
+ description: 查询条件-用户状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 角色的关联用户列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserRolePager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 关联角色的用户
+ operationId: admin-roles-relateUsers
+ tags:
+ - Api1AdminRoleController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 角色ID
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserRoles'
+ responses:
+ '200':
+ description: 设置成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {
+ "success": "info.set.success"
+ }
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ '/admin/roles/{id}/groups':
+ get:
+ summary: 根据ID获取角色的关联用户组
+ operationId: admin-roles-roleGroups
+ tags:
+ - Api1AdminRoleController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 角色ID
+ schema:
+ type: string
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: 'mapBean[groupCode]'
+ in: query
+ description: 查询条件-用户组代码
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[groupName]'
+ in: query
+ description: 查询条件-用户组名称
+ required: false
+ schema:
+ type: string
+ - name: 'mapBean[groupStatus]'
+ in: query
+ description: 查询条件-用户组状态(1 启用,0 停用)
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 角色的关联用户组列表
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupRolePager'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+ post:
+ summary: 关联角色的用户组
+ operationId: admin-roles-relateGroups
+ tags:
+ - Api1AdminRoleController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 角色ID
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupRoles'
+ responses:
+ '200':
+ description: 设置成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {
+ "success": "info.set.success"
+ }
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+components:
+ schemas:
+ Error:
+ required:
+ - code
+ - message
+ properties:
+ code:
+ type: integer
+ format: int32
+ message:
+ type: string
+ Success:
+ properties:
+ success:
+ type: string
+ PagerResponseModel:
+ properties:
+ pageIndex:
+ type: integer
+ format: int32
+ pageSize:
+ type: integer
+ format: int32
+ currentItemCount:
+ type: integer
+ format: int32
+ pageCount:
+ type: integer
+ format: int32
+ recordCount:
+ type: integer
+ format: int64
+ BaseDomain:
+ properties:
+ id:
+ description: ID
+ type: string
+ companyId:
+ description: 'Company ID, 固定 1'
+ type: string
+ deleted:
+ description: 是否删除
+ type: boolean
+ default: false
+ addAccount:
+ description: 创建人
+ type: string
+ addTime:
+ description: 创建时间
+ type: string
+ format: date
+ editAccount:
+ description: 修改人
+ type: string
+ editTime:
+ description: 修改时间
+ type: string
+ format: date
+ deleteAccount:
+ description: 删除人
+ type: string
+ deleteTime:
+ description: 删除时间
+ type: string
+ format: date
+ User:
+ allOf:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ username:
+ description: 用户名
+ type: string
+ password:
+ description: 密码
+ type: string
+ format: password
+ enabled:
+ description: 是否可用,1 可用,0 不可用,默认:1
+ type: boolean
+ default: true
+ accountNonExpired:
+ description: 账号未过期,1 未过期,0 过期,默认:1
+ type: boolean
+ default: true
+ accountNonLocked:
+ description: 账号未锁定,1 未锁定,0 锁定,默认:1
+ type: boolean
+ default: true
+ credentialsNonExpired:
+ description: 密码未过期,1 未过期,0 过期,默认:1
+ type: boolean
+ default: true
+ name:
+ description: 姓名
+ type: string
+ status:
+ description: 状态(1 启用,0 停用)
+ type: string
+ mobile:
+ description: 登录手机
+ type: string
+ email:
+ description: 登录邮箱
+ type: string
+ UserPager:
+ allOf:
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
+ Group:
+ allOf:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ code:
+ description: 代码
+ type: string
+ name:
+ description: 名称
+ type: string
+ memo:
+ description: 备注
+ type: string
+ status:
+ description: 状态(1 启用,0 停用)
+ type: string
+ GroupPager:
+ allOf:
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/Group'
+ Role:
+ allOf:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ code:
+ description: 代码
+ type: string
+ name:
+ description: 名称
+ type: string
+ memo:
+ description: 备注
+ type: string
+ status:
+ description: 状态(1 启用,0 停用)
+ type: string
+ RolePager:
+ allOf:
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/Role'
+ GroupUser:
+ allOf:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ groupId:
+ description: 用户组ID
+ type: string
+ username:
+ description: 用户名
+ type: string
+ GroupUserPager:
+ allOf:
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/GroupUser'
+ GroupUsers:
+ properties:
+ groupUsers:
+ type: array
+ items:
+ $ref: '#/components/schemas/GroupUser'
+ UserRole:
+ allOf:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ username:
+ description: 用户名
+ type: string
+ rolecode:
+ description: 角色代码
+ type: string
+ UserRolePager:
+ allOf:
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserRole'
+ UserRoles:
+ properties:
+ userRoles:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserRole'
+ GroupRole:
+ allOf:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ groupId:
+ description: 用户组ID
+ type: string
+ rolecode:
+ description: 角色代码
+ type: string
+ GroupRolePager:
+ allOf:
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/GroupRole'
+ GroupRoles:
+ properties:
+ groupRoles:
+ type: array
+ items:
+ $ref: '#/components/schemas/GroupRole'