# yeb **Repository Path**: git-hzm/yeb ## Basic Information - **Project Name**: yeb - **Description**: 云e办后端,目前完成登录,验证码,职位管理,职称管理,security动态权限控制 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2021-08-17 - **Last Updated**: 2021-09-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README **云e办接口文档** **简介**:

接口文档

**HOST**:localhost:8081 **联系人**: **Version**: **接口路径**:/v2/api-docs # chat-controller ## 获取所有操作员 **接口描述**: **接口地址**:`/chat/admin` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |keywords| keywords | query | false |string | | **响应示例**: ```json [ { "accountNonExpired": true, "accountNonLocked": true, "address": "", "authorities": [ { "authority": "" } ], "credentialsNonExpired": true, "enabled": true, "id": 0, "name": "", "password": "", "phone": "", "remark": "", "roles": [ { "id": 0, "name": "", "nameZh": "" } ], "telephone": "", "userFace": "", "username": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |accountNonExpired| |boolean | | |accountNonLocked| |boolean | | |address| 联系地址 |string | | |authorities| |array | GrantedAuthority | |credentialsNonExpired| |boolean | | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |name| 姓名 |string | | |password| 密码 |string | | |phone| 手机号码 |string | | |remark| 备注 |string | | |roles| 角色 |array | Role对象 | |telephone| 住宅电话 |string | | |userFace| 用户头像 |string | | |username| 用户名 |string | | **schema属性说明** **GrantedAuthority** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |authority | |string | | **Role对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |id | id |integer(int32) | | |name | 名称 |string | | |nameZh | 角色名称 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Admin对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || # 个人中心管理 ## 更新当前用户信息 **接口描述**: **接口地址**:`/admin/info` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "accountNonExpired": true, "accountNonLocked": true, "address": "", "authorities": [ { "authority": "" } ], "credentialsNonExpired": true, "enabled": true, "id": 0, "name": "", "password": "", "phone": "", "remark": "", "roles": [ { "id": 0, "name": "", "nameZh": "" } ], "telephone": "", "userFace": "", "username": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |admin| admin | body | true |Admin对象 | Admin对象 | |authenticated| | query | false |boolean | | |authorities[0].authority| | query | false |string | | |credentials| | query | false |object | | |details| | query | false |object | | |principal| | query | false |object | | **schema属性说明** **Admin对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |accountNonExpired| | body | false |boolean | | |accountNonLocked| | body | false |boolean | | |address| 联系地址 | body | false |string | | |authorities| | body | false |array | GrantedAuthority | |credentialsNonExpired| | body | false |boolean | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 姓名 | body | false |string | | |password| 密码 | body | false |string | | |phone| 手机号码 | body | false |string | | |remark| 备注 | body | false |string | | |roles| 角色 | body | false |array | Role对象 | |telephone| 住宅电话 | body | false |string | | |userFace| 用户头像 | body | false |string | | |username| 用户名 | body | false |string | | **GrantedAuthority** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |authority| | body | false |string | | **Role对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | body | false |integer(int32) | | |name| 名称 | body | false |string | | |nameZh| 角色名称 | body | false |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新用户密码 **接口描述**: **接口地址**:`/admin/pass` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |info| info | body | true |object | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || # 员工管理 ## 获取所有员工(分页) **接口描述**: **接口地址**:`/employee/basic/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |address| 联系地址 | query | false |string | | |beginContract| 合同起始日期 | query | false |string | | |beginDate| 入职日期 | query | false |string | | |beginDateScope| beginDateScope | query | false |string | | |birthday| 出生日期 | query | false |string | | |contractTerm| 合同期限 | query | false |number | | |conversionTime| 转正日期 | query | false |string | | |currentPage| currentPage | query | false |integer | | |department.depPath| 路径 | query | false |string | | |department.enabled| 是否启用 | query | false |boolean | | |department.id| id | query | false |integer | | |department.isParent| 是否上级 | query | false |boolean | | |department.name| 部门名称 | query | false |string | | |department.parentId| 父id | query | false |integer | | |department.result| 返回结果,存储过程是由 | query | false |integer | | |departmentId| 所属部门 | query | false |integer | | |email| 邮箱 | query | false |string | | |endContract| 合同终止日期 | query | false |string | | |engageForm| 聘用形式 | query | false |string | | |gender| 性别 | query | false |string | | |id| 员工编号 | query | false |integer | | |idCard| 身份证号 | query | false |string | | |joblevel.createDate| 创建时间 | query | false |string | | |joblevel.enabled| 是否启用 | query | false |boolean | | |joblevel.id| id | query | false |integer | | |joblevel.name| 职称名称 | query | false |string | | |joblevel.titleLevel| 职称等级 | query | false |string | | |jobLevelId| 职称ID | query | false |integer | | |name| 员工姓名 | query | false |string | | |nation.id| id | query | false |integer | | |nation.name| 民族 | query | false |string | | |nationId| 民族 | query | false |integer | | |nativePlace| 籍贯 | query | false |string | | |notWorkDate| 离职日期 | query | false |string | | |phone| 电话号码 | query | false |string | | |politicId| 政治面貌 | query | false |integer | | |politicsStatus.id| id | query | false |integer | | |politicsStatus.name| 政治面貌 | query | false |string | | |posId| 职位ID | query | false |integer | | |position.createDate| 创建时间 | query | false |string | | |position.enabled| 是否启用 | query | false |boolean | | |position.id| id | query | false |integer | | |position.name| 职位 | query | false |string | | |salary.accumulationFundBase| 公积金基数 | query | false |integer | | |salary.accumulationFundPer| 公积金比率 | query | false |number | | |salary.allSalary| 应发工资 | query | false |integer | | |salary.basicSalary| 基本工资 | query | false |integer | | |salary.bonus| 奖金 | query | false |integer | | |salary.createDate| 启用时间 | query | false |string | | |salary.id| id | query | false |integer | | |salary.lunchSalary| 午餐补助 | query | false |integer | | |salary.medicalBase| 医疗基数 | query | false |integer | | |salary.medicalPer| 医疗保险比率 | query | false |number | | |salary.name| 名称 | query | false |string | | |salary.pensionBase| 养老金基数 | query | false |integer | | |salary.pensionPer| 养老金比率 | query | false |number | | |salary.trafficSalary| 交通补助 | query | false |integer | | |salaryId| 工资账套ID | query | false |integer | | |school| 毕业院校 | query | false |string | | |size| size | query | false |integer | | |specialty| 所属专业 | query | false |string | | |tiptopDegree| 最高学历 | query | false |string | | |wedlock| 婚姻状况 | query | false |string | | |workAge| 工龄 | query | false |integer | | |workID| 工号 | query | false |string | | |workState| 在职状态 | query | false |string | | **响应示例**: ```json { "data": [], "toral": 0 } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |data| |array | | |toral| |integer(int64) | integer(int64) | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespPageBean| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 添加员工 **接口描述**: **接口地址**:`/employee/basic/` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "address": "", "beginContract": "", "beginDate": "", "birthday": "", "contractTerm": 0, "conversionTime": "", "department": { "children": [ { "children": [ {} ], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 }, "departmentId": 0, "email": "", "endContract": "", "engageForm": "", "gender": "", "id": 0, "idCard": "", "jobLevelId": 0, "joblevel": { "createDate": "", "enabled": true, "id": 0, "name": "", "titleLevel": "" }, "name": "", "nation": { "id": 0, "name": "" }, "nationId": 0, "nativePlace": "", "notWorkDate": "", "phone": "", "politicId": 0, "politicsStatus": { "id": 0, "name": "" }, "posId": 0, "position": { "createDate": "", "enabled": true, "id": 0, "name": "" }, "salary": { "accumulationFundBase": 0, "accumulationFundPer": 0, "allSalary": 0, "basicSalary": 0, "bonus": 0, "createDate": "", "id": 0, "lunchSalary": 0, "medicalBase": 0, "medicalPer": 0, "name": "", "pensionBase": 0, "pensionPer": 0, "trafficSalary": 0 }, "salaryId": 0, "school": "", "specialty": "", "tiptopDegree": "", "wedlock": "", "workAge": 0, "workID": "", "workState": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |employee| employee | body | true |Employee对象 | Employee对象 | **schema属性说明** **Employee对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |address| 联系地址 | body | false |string | | |beginContract| 合同起始日期 | body | false |string(date) | | |beginDate| 入职日期 | body | false |string(date) | | |birthday| 出生日期 | body | false |string(date) | | |contractTerm| 合同期限 | body | false |number(double) | | |conversionTime| 转正日期 | body | false |string(date) | | |department| 部门 | body | false |Department对象 | Department对象 | |departmentId| 所属部门 | body | false |integer(int32) | | |email| 邮箱 | body | false |string | | |endContract| 合同终止日期 | body | false |string(date) | | |engageForm| 聘用形式 | body | false |string | | |gender| 性别 | body | false |string | | |id| 员工编号 | body | false |integer(int32) | | |idCard| 身份证号 | body | false |string | | |jobLevelId| 职称ID | body | false |integer(int32) | | |joblevel| 职称 | body | false |Joblevel对象 | Joblevel对象 | |name| 员工姓名 | body | false |string | | |nation| 民族 | body | false |Nation对象 | Nation对象 | |nationId| 民族 | body | false |integer(int32) | | |nativePlace| 籍贯 | body | false |string | | |notWorkDate| 离职日期 | body | false |string(date) | | |phone| 电话号码 | body | false |string | | |politicId| 政治面貌 | body | false |integer(int32) | | |politicsStatus| 政治面貌 | body | false |PoliticsStatus对象 | PoliticsStatus对象 | |posId| 职位ID | body | false |integer(int32) | | |position| 职位 | body | false |Position对象 | Position对象 | |salary| 工资账套 | body | false |Salary对象 | Salary对象 | |salaryId| 工资账套ID | body | false |integer(int32) | | |school| 毕业院校 | body | false |string | | |specialty| 所属专业 | body | false |string | | |tiptopDegree| 最高学历 | body | false |string | | |wedlock| 婚姻状况 | body | false |string | | |workAge| 工龄 | body | false |integer(int32) | | |workID| 工号 | body | false |string | | |workState| 在职状态 | body | false |string | | **Department对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |children| 子部门列表 | body | false |array | Department对象 | |depPath| 路径 | body | false |string | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |isParent| 是否上级 | body | false |boolean | | |name| 部门名称 | body | false |string | | |parentId| 父id | body | false |integer(int32) | | |result| 返回结果,存储过程是由 | body | false |integer(int32) | | **Joblevel对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职称名称 | body | false |string | | |titleLevel| 职称等级 | body | false |string | | **Nation对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | body | false |integer(int32) | | |name| 民族 | body | false |string | | **PoliticsStatus对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | body | false |integer(int32) | | |name| 政治面貌 | body | false |string | | **Position对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职位 | body | false |string | | **Salary对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |accumulationFundBase| 公积金基数 | body | false |integer(int32) | | |accumulationFundPer| 公积金比率 | body | false |number(float) | | |allSalary| 应发工资 | body | false |integer(int32) | | |basicSalary| 基本工资 | body | false |integer(int32) | | |bonus| 奖金 | body | false |integer(int32) | | |createDate| 启用时间 | body | false |string(date-time) | | |id| id | body | false |integer(int32) | | |lunchSalary| 午餐补助 | body | false |integer(int32) | | |medicalBase| 医疗基数 | body | false |integer(int32) | | |medicalPer| 医疗保险比率 | body | false |number(float) | | |name| 名称 | body | false |string | | |pensionBase| 养老金基数 | body | false |integer(int32) | | |pensionPer| 养老金比率 | body | false |number(float) | | |trafficSalary| 交通补助 | body | false |integer(int32) | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新员工 **接口描述**: **接口地址**:`/employee/basic/` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "address": "", "beginContract": "", "beginDate": "", "birthday": "", "contractTerm": 0, "conversionTime": "", "department": { "children": [ { "children": [ {} ], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 }, "departmentId": 0, "email": "", "endContract": "", "engageForm": "", "gender": "", "id": 0, "idCard": "", "jobLevelId": 0, "joblevel": { "createDate": "", "enabled": true, "id": 0, "name": "", "titleLevel": "" }, "name": "", "nation": { "id": 0, "name": "" }, "nationId": 0, "nativePlace": "", "notWorkDate": "", "phone": "", "politicId": 0, "politicsStatus": { "id": 0, "name": "" }, "posId": 0, "position": { "createDate": "", "enabled": true, "id": 0, "name": "" }, "salary": { "accumulationFundBase": 0, "accumulationFundPer": 0, "allSalary": 0, "basicSalary": 0, "bonus": 0, "createDate": "", "id": 0, "lunchSalary": 0, "medicalBase": 0, "medicalPer": 0, "name": "", "pensionBase": 0, "pensionPer": 0, "trafficSalary": 0 }, "salaryId": 0, "school": "", "specialty": "", "tiptopDegree": "", "wedlock": "", "workAge": 0, "workID": "", "workState": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |employee| employee | body | true |Employee对象 | Employee对象 | **schema属性说明** **Employee对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |address| 联系地址 | body | false |string | | |beginContract| 合同起始日期 | body | false |string(date) | | |beginDate| 入职日期 | body | false |string(date) | | |birthday| 出生日期 | body | false |string(date) | | |contractTerm| 合同期限 | body | false |number(double) | | |conversionTime| 转正日期 | body | false |string(date) | | |department| 部门 | body | false |Department对象 | Department对象 | |departmentId| 所属部门 | body | false |integer(int32) | | |email| 邮箱 | body | false |string | | |endContract| 合同终止日期 | body | false |string(date) | | |engageForm| 聘用形式 | body | false |string | | |gender| 性别 | body | false |string | | |id| 员工编号 | body | false |integer(int32) | | |idCard| 身份证号 | body | false |string | | |jobLevelId| 职称ID | body | false |integer(int32) | | |joblevel| 职称 | body | false |Joblevel对象 | Joblevel对象 | |name| 员工姓名 | body | false |string | | |nation| 民族 | body | false |Nation对象 | Nation对象 | |nationId| 民族 | body | false |integer(int32) | | |nativePlace| 籍贯 | body | false |string | | |notWorkDate| 离职日期 | body | false |string(date) | | |phone| 电话号码 | body | false |string | | |politicId| 政治面貌 | body | false |integer(int32) | | |politicsStatus| 政治面貌 | body | false |PoliticsStatus对象 | PoliticsStatus对象 | |posId| 职位ID | body | false |integer(int32) | | |position| 职位 | body | false |Position对象 | Position对象 | |salary| 工资账套 | body | false |Salary对象 | Salary对象 | |salaryId| 工资账套ID | body | false |integer(int32) | | |school| 毕业院校 | body | false |string | | |specialty| 所属专业 | body | false |string | | |tiptopDegree| 最高学历 | body | false |string | | |wedlock| 婚姻状况 | body | false |string | | |workAge| 工龄 | body | false |integer(int32) | | |workID| 工号 | body | false |string | | |workState| 在职状态 | body | false |string | | **Department对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |children| 子部门列表 | body | false |array | Department对象 | |depPath| 路径 | body | false |string | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |isParent| 是否上级 | body | false |boolean | | |name| 部门名称 | body | false |string | | |parentId| 父id | body | false |integer(int32) | | |result| 返回结果,存储过程是由 | body | false |integer(int32) | | **Joblevel对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职称名称 | body | false |string | | |titleLevel| 职称等级 | body | false |string | | **Nation对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | body | false |integer(int32) | | |name| 民族 | body | false |string | | **PoliticsStatus对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | body | false |integer(int32) | | |name| 政治面貌 | body | false |string | | **Position对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职位 | body | false |string | | **Salary对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |accumulationFundBase| 公积金基数 | body | false |integer(int32) | | |accumulationFundPer| 公积金比率 | body | false |number(float) | | |allSalary| 应发工资 | body | false |integer(int32) | | |basicSalary| 基本工资 | body | false |integer(int32) | | |bonus| 奖金 | body | false |integer(int32) | | |createDate| 启用时间 | body | false |string(date-time) | | |id| id | body | false |integer(int32) | | |lunchSalary| 午餐补助 | body | false |integer(int32) | | |medicalBase| 医疗基数 | body | false |integer(int32) | | |medicalPer| 医疗保险比率 | body | false |number(float) | | |name| 名称 | body | false |string | | |pensionBase| 养老金基数 | body | false |integer(int32) | | |pensionPer| 养老金比率 | body | false |number(float) | | |trafficSalary| 交通补助 | body | false |integer(int32) | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取所有部门 **接口描述**: **接口地址**:`/employee/basic/deps` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "children": [ { "children": [], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |children| 子部门列表 |array | Department对象 | |depPath| 路径 |string | | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |isParent| 是否上级 |boolean | | |name| 部门名称 |string | | |parentId| 父id |integer(int32) | integer(int32) | |result| 返回结果,存储过程是由 |integer(int32) | integer(int32) | **schema属性说明** **Department对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |children | 子部门列表 |array | Department对象 | |depPath | 路径 |string | | |enabled | 是否启用 |boolean | | |id | id |integer(int32) | | |isParent | 是否上级 |boolean | | |name | 部门名称 |string | | |parentId | 父id |integer(int32) | | |result | 返回结果,存储过程是由 |integer(int32) | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Department对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 导出员工数据 **接口描述**: **接口地址**:`/employee/basic/export` **请求方式**:`GET` **consumes**:`` **produces**:`["application/octet-stream"]` **请求参数**: 暂无 **响应示例**: ```json ``` **响应参数**: 暂无 **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 导入员工数据 **接口描述**: **接口地址**:`/employee/basic/import` **请求方式**:`POST` **consumes**:`["multipart/form-data"]` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |file| | formData | false |file | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取所有职称 **接口描述**: **接口地址**:`/employee/basic/joblevels` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "createDate": "", "enabled": true, "id": 0, "name": "", "titleLevel": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |createDate| 创建时间 |string(date-time) | string(date-time) | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |name| 职称名称 |string | | |titleLevel| 职称等级 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Joblevel对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取工号 **接口描述**: **接口地址**:`/employee/basic/maxWorkId` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取所有民族 **接口描述**: **接口地址**:`/employee/basic/nations` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "id": 0, "name": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |id| id |integer(int32) | integer(int32) | |name| 民族 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Nation对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取所有政治面貌 **接口描述**: **接口地址**:`/employee/basic/politicsstatus` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "id": 0, "name": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |id| id |integer(int32) | integer(int32) | |name| 政治面貌 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |PoliticsStatus对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取所有职位 **接口描述**: **接口地址**:`/employee/basic/positions` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "createDate": "", "enabled": true, "id": 0, "name": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |createDate| 创建时间 |string(date-time) | string(date-time) | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |name| 职位 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Position对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 删除员工 **接口描述**: **接口地址**:`/employee/basic/{id}` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | path | true |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || # 工资账套管理 ## 获取所有工资帐套 **接口描述**: **接口地址**:`/salary/sob/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "accumulationFundBase": 0, "accumulationFundPer": 0, "allSalary": 0, "basicSalary": 0, "bonus": 0, "createDate": "", "id": 0, "lunchSalary": 0, "medicalBase": 0, "medicalPer": 0, "name": "", "pensionBase": 0, "pensionPer": 0, "trafficSalary": 0 } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |accumulationFundBase| 公积金基数 |integer(int32) | integer(int32) | |accumulationFundPer| 公积金比率 |number(float) | number(float) | |allSalary| 应发工资 |integer(int32) | integer(int32) | |basicSalary| 基本工资 |integer(int32) | integer(int32) | |bonus| 奖金 |integer(int32) | integer(int32) | |createDate| 启用时间 |string(date-time) | string(date-time) | |id| id |integer(int32) | integer(int32) | |lunchSalary| 午餐补助 |integer(int32) | integer(int32) | |medicalBase| 医疗基数 |integer(int32) | integer(int32) | |medicalPer| 医疗保险比率 |number(float) | number(float) | |name| 名称 |string | | |pensionBase| 养老金基数 |integer(int32) | integer(int32) | |pensionPer| 养老金比率 |number(float) | number(float) | |trafficSalary| 交通补助 |integer(int32) | integer(int32) | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Salary对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 添加工资账套 **接口描述**: **接口地址**:`/salary/sob/` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "accumulationFundBase": 0, "accumulationFundPer": 0, "allSalary": 0, "basicSalary": 0, "bonus": 0, "createDate": "", "id": 0, "lunchSalary": 0, "medicalBase": 0, "medicalPer": 0, "name": "", "pensionBase": 0, "pensionPer": 0, "trafficSalary": 0 } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |salary| salary | body | true |Salary对象 | Salary对象 | **schema属性说明** **Salary对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |accumulationFundBase| 公积金基数 | body | false |integer(int32) | | |accumulationFundPer| 公积金比率 | body | false |number(float) | | |allSalary| 应发工资 | body | false |integer(int32) | | |basicSalary| 基本工资 | body | false |integer(int32) | | |bonus| 奖金 | body | false |integer(int32) | | |createDate| 启用时间 | body | false |string(date-time) | | |id| id | body | false |integer(int32) | | |lunchSalary| 午餐补助 | body | false |integer(int32) | | |medicalBase| 医疗基数 | body | false |integer(int32) | | |medicalPer| 医疗保险比率 | body | false |number(float) | | |name| 名称 | body | false |string | | |pensionBase| 养老金基数 | body | false |integer(int32) | | |pensionPer| 养老金比率 | body | false |number(float) | | |trafficSalary| 交通补助 | body | false |integer(int32) | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新工资账套 **接口描述**: **接口地址**:`/salary/sob/` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "accumulationFundBase": 0, "accumulationFundPer": 0, "allSalary": 0, "basicSalary": 0, "bonus": 0, "createDate": "", "id": 0, "lunchSalary": 0, "medicalBase": 0, "medicalPer": 0, "name": "", "pensionBase": 0, "pensionPer": 0, "trafficSalary": 0 } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |salary| salary | body | true |Salary对象 | Salary对象 | **schema属性说明** **Salary对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |accumulationFundBase| 公积金基数 | body | false |integer(int32) | | |accumulationFundPer| 公积金比率 | body | false |number(float) | | |allSalary| 应发工资 | body | false |integer(int32) | | |basicSalary| 基本工资 | body | false |integer(int32) | | |bonus| 奖金 | body | false |integer(int32) | | |createDate| 启用时间 | body | false |string(date-time) | | |id| id | body | false |integer(int32) | | |lunchSalary| 午餐补助 | body | false |integer(int32) | | |medicalBase| 医疗基数 | body | false |integer(int32) | | |medicalPer| 医疗保险比率 | body | false |number(float) | | |name| 名称 | body | false |string | | |pensionBase| 养老金基数 | body | false |integer(int32) | | |pensionPer| 养老金比率 | body | false |number(float) | | |trafficSalary| 交通补助 | body | false |integer(int32) | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 删除工资账套 **接口描述**: **接口地址**:`/salary/sob/{id}` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | path | true |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || # 工资账套管理接口 ## 获取所有员工账套 **接口描述**: **接口地址**:`/salary/sobcfg/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |currenttPage| currenttPage | query | false |integer | | |size| size | query | false |integer | | **响应示例**: ```json { "data": [], "toral": 0 } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |data| |array | | |toral| |integer(int64) | integer(int64) | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespPageBean| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新员工账套 **接口描述**: **接口地址**:`/salary/sobcfg/` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |eid| eid | query | false |integer | | |sid| sid | query | false |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取所有工资账套 **接口描述**: **接口地址**:`/salary/sobcfg/salaries` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "accumulationFundBase": 0, "accumulationFundPer": 0, "allSalary": 0, "basicSalary": 0, "bonus": 0, "createDate": "", "id": 0, "lunchSalary": 0, "medicalBase": 0, "medicalPer": 0, "name": "", "pensionBase": 0, "pensionPer": 0, "trafficSalary": 0 } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |accumulationFundBase| 公积金基数 |integer(int32) | integer(int32) | |accumulationFundPer| 公积金比率 |number(float) | number(float) | |allSalary| 应发工资 |integer(int32) | integer(int32) | |basicSalary| 基本工资 |integer(int32) | integer(int32) | |bonus| 奖金 |integer(int32) | integer(int32) | |createDate| 启用时间 |string(date-time) | string(date-time) | |id| id |integer(int32) | integer(int32) | |lunchSalary| 午餐补助 |integer(int32) | integer(int32) | |medicalBase| 医疗基数 |integer(int32) | integer(int32) | |medicalPer| 医疗保险比率 |number(float) | number(float) | |name| 名称 |string | | |pensionBase| 养老金基数 |integer(int32) | integer(int32) | |pensionPer| 养老金比率 |number(float) | number(float) | |trafficSalary| 交通补助 |integer(int32) | integer(int32) | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Salary对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || # 测试接口controller ## 高级权限判断 **接口描述**: **接口地址**:`/employee/advanced/hello` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json ``` **响应参数**: 暂无 **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 返回一个hello **接口描述**: **接口地址**:`/hello` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |isok| isok | query | false |boolean | | **响应示例**: ```json ``` **响应参数**: 暂无 **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || # 登录接口管理controller ## 查看当前登录信息 **接口描述**: **接口地址**:`/admin/info` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |name| | query | false |string | | **响应示例**: ```json { "accountNonExpired": true, "accountNonLocked": true, "address": "", "authorities": [ { "authority": "" } ], "credentialsNonExpired": true, "enabled": true, "id": 0, "name": "", "password": "", "phone": "", "remark": "", "roles": [ { "id": 0, "name": "", "nameZh": "" } ], "telephone": "", "userFace": "", "username": "" } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |accountNonExpired| |boolean | | |accountNonLocked| |boolean | | |address| 联系地址 |string | | |authorities| |array | GrantedAuthority | |credentialsNonExpired| |boolean | | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |name| 姓名 |string | | |password| 密码 |string | | |phone| 手机号码 |string | | |remark| 备注 |string | | |roles| 角色 |array | Role对象 | |telephone| 住宅电话 |string | | |userFace| 用户头像 |string | | |username| 用户名 |string | | **schema属性说明** **GrantedAuthority** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |authority | |string | | **Role对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |id | id |integer(int32) | | |name | 名称 |string | | |nameZh | 角色名称 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Admin对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 登录接口 **接口描述**: **接口地址**:`/login` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "code": "", "password": "", "username": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |adminLoginParam| adminLoginParam | body | true |adminLogin对象 | adminLogin对象 | **schema属性说明** **adminLogin对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |code| 验证码 | body | true |string | | |password| 密码 | body | true |string | | |username| 用户名 | body | true |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 退出登录 **接口描述**: **接口地址**:`/logout` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || # 管理员接口 ## 更新操作员 **接口描述**: **接口地址**:`/sytem/admin` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "address": "", "enabled": true, "id": 0, "name": "", "password": "", "phone": "", "remark": "", "roles": [ { "id": 0, "name": "", "nameZh": "" } ], "telephone": "", "userFace": "", "username": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |admin| admin | body | true |Admin对象Req | Admin对象Req | **schema属性说明** **Admin对象Req** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |address| 联系地址 | body | false |string | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 姓名 | body | false |string | | |password| 密码 | body | false |string | | |phone| 手机号码 | body | false |string | | |remark| 备注 | body | false |string | | |roles| 角色 | body | false |array | Role对象 | |telephone| 住宅电话 | body | false |string | | |userFace| 用户头像 | body | false |string | | |username| 用户名 | body | false |string | | **Role对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | body | false |integer(int32) | | |name| 名称 | body | false |string | | |nameZh| 角色名称 | body | false |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 删除操作员 **接口描述**: **接口地址**:`/sytem/admin` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | query | true |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || ## 获取所有管理员 **接口描述**: **接口地址**:`/sytem/admin/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |keywords| keywords | query | false |string | | **响应示例**: ```json [ { "accountNonExpired": true, "accountNonLocked": true, "address": "", "authorities": [ { "authority": "" } ], "credentialsNonExpired": true, "enabled": true, "id": 0, "name": "", "password": "", "phone": "", "remark": "", "roles": [ { "id": 0, "name": "", "nameZh": "" } ], "telephone": "", "userFace": "", "username": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |accountNonExpired| |boolean | | |accountNonLocked| |boolean | | |address| 联系地址 |string | | |authorities| |array | GrantedAuthority | |credentialsNonExpired| |boolean | | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |name| 姓名 |string | | |password| 密码 |string | | |phone| 手机号码 |string | | |remark| 备注 |string | | |roles| 角色 |array | Role对象 | |telephone| 住宅电话 |string | | |userFace| 用户头像 |string | | |username| 用户名 |string | | **schema属性说明** **GrantedAuthority** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |authority | |string | | **Role对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |id | id |integer(int32) | | |name | 名称 |string | | |nameZh | 角色名称 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Admin对象Res| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新操作员角色 **接口描述**: **接口地址**:`/sytem/admin/role` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |adminId| adminId | query | false |integer | | |rids| rids | query | false |array | integer | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 获取所有角色 **接口描述**: **接口地址**:`/sytem/admin/roles` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "id": 0, "name": "", "nameZh": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |id| id |integer(int32) | integer(int32) | |name| 名称 |string | | |nameZh| 角色名称 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Role对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || # 职位管理 ## 获取所有职位信息 **接口描述**: **接口地址**:`/system/basic/pos/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "createDate": "", "enabled": true, "id": 0, "name": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |createDate| 创建时间 |string(date-time) | string(date-time) | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |name| 职位 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Position对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 添加职位 **接口描述**: **接口地址**:`/system/basic/pos/` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "createDate": "", "enabled": true, "id": 0, "name": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |position| position | body | true |Position对象 | Position对象 | **schema属性说明** **Position对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职位 | body | false |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新职位 **接口描述**: **接口地址**:`/system/basic/pos/` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "createDate": "", "enabled": true, "id": 0, "name": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |position| position | body | true |Position对象 | Position对象 | **schema属性说明** **Position对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职位 | body | false |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 批量删除职位 **接口描述**: **接口地址**:`/system/basic/pos/` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |ids| ids | query | false |array | integer | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || ## 删除职位 **接口描述**: **接口地址**:`/system/basic/pos/{id}` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | path | true |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || # 职称管理 ## 获取所有职称信息 **接口描述**: **接口地址**:`/system/basic/joblevel/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "createDate": "", "enabled": true, "id": 0, "name": "", "titleLevel": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |createDate| 创建时间 |string(date-time) | string(date-time) | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |name| 职称名称 |string | | |titleLevel| 职称等级 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Joblevel对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 添加职称 **接口描述**: **接口地址**:`/system/basic/joblevel/` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "createDate": "", "enabled": true, "id": 0, "name": "", "titleLevel": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |joblevel| joblevel | body | true |Joblevel对象 | Joblevel对象 | **schema属性说明** **Joblevel对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职称名称 | body | false |string | | |titleLevel| 职称等级 | body | false |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新职称 **接口描述**: **接口地址**:`/system/basic/joblevel/` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "createDate": "", "enabled": true, "id": 0, "name": "", "titleLevel": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |joblevel| joblevel | body | true |Joblevel对象 | Joblevel对象 | **schema属性说明** **Joblevel对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |createDate| 创建时间 | body | false |string(date-time) | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |name| 职称名称 | body | false |string | | |titleLevel| 职称等级 | body | false |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 批量删除职位 **接口描述**: **接口地址**:`/system/basic/joblevel/` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |ids| ids | query | false |array | integer | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || ## 删除职称 **接口描述**: **接口地址**:`/system/basic/joblevel/{id}` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | path | true |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || # 菜单接口 ## 通过用户id查菜单列表 **接口描述**: **接口地址**:`/system/cfg/menu` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "children": [ { "children": [], "component": "", "enabled": true, "iconCls": "", "id": 0, "keepAlive": true, "name": "", "parentId": 0, "path": "", "requireAuth": true, "roles": [], "url": "" } ], "component": "", "enabled": true, "iconCls": "", "id": 0, "keepAlive": true, "name": "", "parentId": 0, "path": "", "requireAuth": true, "roles": [ { "id": 0, "name": "", "nameZh": "" } ], "url": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |children| 子菜单 |array | Menu对象 | |component| 组件 |string | | |enabled| 是否启用 |boolean | | |iconCls| 图标 |string | | |id| id |integer(int32) | integer(int32) | |keepAlive| 是否保持激活 |boolean | | |name| 菜单名 |string | | |parentId| 父id |integer(int32) | integer(int32) | |path| path |string | | |requireAuth| 是否要求权限 |boolean | | |roles| 角色列表 |array | Role对象 | |url| url |string | | **schema属性说明** **Menu对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |children | 子菜单 |array | Menu对象 | |component | 组件 |string | | |enabled | 是否启用 |boolean | | |iconCls | 图标 |string | | |id | id |integer(int32) | | |keepAlive | 是否保持激活 |boolean | | |name | 菜单名 |string | | |parentId | 父id |integer(int32) | | |path | path |string | | |requireAuth | 是否要求权限 |boolean | | |roles | 角色列表 |array | Role对象 | |url | url |string | | **Role对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |id | id |integer(int32) | | |name | 名称 |string | | |nameZh | 角色名称 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Menu对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || # 角色管理 ## 获取所有角色 **接口描述**: **接口地址**:`/system/basic/permiss/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "id": 0, "name": "", "nameZh": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |id| id |integer(int32) | integer(int32) | |name| 名称 |string | | |nameZh| 角色名称 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Role对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 添加角色 **接口描述**: **接口地址**:`/system/basic/permiss/` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "id": 0, "name": "", "nameZh": "" } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |role| role | body | true |Role对象 | Role对象 | **schema属性说明** **Role对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | body | false |integer(int32) | | |name| 名称 | body | false |string | | |nameZh| 角色名称 | body | false |string | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 更新角色菜单 **接口描述**: **接口地址**:`/system/basic/permiss/` **请求方式**:`PUT` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |mids| mids | query | false |array | integer | |rid| rid | query | false |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 查询所有菜单 **接口描述**: **接口地址**:`/system/basic/permiss/menus` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "children": [ { "children": [], "component": "", "enabled": true, "iconCls": "", "id": 0, "keepAlive": true, "name": "", "parentId": 0, "path": "", "requireAuth": true, "roles": [], "url": "" } ], "component": "", "enabled": true, "iconCls": "", "id": 0, "keepAlive": true, "name": "", "parentId": 0, "path": "", "requireAuth": true, "roles": [ { "id": 0, "name": "", "nameZh": "" } ], "url": "" } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |children| 子菜单 |array | Menu对象 | |component| 组件 |string | | |enabled| 是否启用 |boolean | | |iconCls| 图标 |string | | |id| id |integer(int32) | integer(int32) | |keepAlive| 是否保持激活 |boolean | | |name| 菜单名 |string | | |parentId| 父id |integer(int32) | integer(int32) | |path| path |string | | |requireAuth| 是否要求权限 |boolean | | |roles| 角色列表 |array | Role对象 | |url| url |string | | **schema属性说明** **Menu对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |children | 子菜单 |array | Menu对象 | |component | 组件 |string | | |enabled | 是否启用 |boolean | | |iconCls | 图标 |string | | |id | id |integer(int32) | | |keepAlive | 是否保持激活 |boolean | | |name | 菜单名 |string | | |parentId | 父id |integer(int32) | | |path | path |string | | |requireAuth | 是否要求权限 |boolean | | |roles | 角色列表 |array | Role对象 | |url | url |string | | **Role对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |id | id |integer(int32) | | |name | 名称 |string | | |nameZh | 角色名称 |string | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Menu对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 根据角色id查询菜单id **接口描述**: **接口地址**:`/system/basic/permiss/mid/{rid}` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |rid| rid | path | true |integer | | **响应示例**: ```json ``` **响应参数**: 暂无 **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 删除角色 **接口描述**: **接口地址**:`/system/basic/permiss/role/{rid}` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |rid| rid | path | true |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || # 部门管理 ## 获取所有部门 **接口描述**: **接口地址**:`/system/basic/department/` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*"]` **请求参数**: 暂无 **响应示例**: ```json [ { "children": [ { "children": [], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ] ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |children| 子部门列表 |array | Department对象 | |depPath| 路径 |string | | |enabled| 是否启用 |boolean | | |id| id |integer(int32) | integer(int32) | |isParent| 是否上级 |boolean | | |name| 部门名称 |string | | |parentId| 父id |integer(int32) | integer(int32) | |result| 返回结果,存储过程是由 |integer(int32) | integer(int32) | **schema属性说明** **Department对象** | 参数名称 | 参数说明 | 类型 | schema | | ------------ | ------------------|--------|----------- | |children | 子部门列表 |array | Department对象 | |depPath | 路径 |string | | |enabled | 是否启用 |boolean | | |id | id |integer(int32) | | |isParent | 是否上级 |boolean | | |name | 部门名称 |string | | |parentId | 父id |integer(int32) | | |result | 返回结果,存储过程是由 |integer(int32) | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |Department对象| | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 添加部门 **接口描述**: **接口地址**:`/system/basic/department/` **请求方式**:`POST` **consumes**:`["application/json"]` **produces**:`["*/*"]` **请求示例**: ```json { "children": [ { "children": [], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ], "depPath": "", "enabled": true, "id": 0, "isParent": true, "name": "", "parentId": 0, "result": 0 } ``` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |dep| dep | body | true |Department对象 | Department对象 | **schema属性说明** **Department对象** | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |children| 子部门列表 | body | false |array | Department对象 | |depPath| 路径 | body | false |string | | |enabled| 是否启用 | body | false |boolean | | |id| id | body | false |integer(int32) | | |isParent| 是否上级 | body | false |boolean | | |name| 部门名称 | body | false |string | | |parentId| 父id | body | false |integer(int32) | | |result| 返回结果,存储过程是由 | body | false |integer(int32) | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 201 | Created || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found || ## 删除部门 **接口描述**: **接口地址**:`/system/basic/department/{id}` **请求方式**:`DELETE` **consumes**:`` **produces**:`["*/*"]` **请求参数**: | 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema | | ------------ | -------------------------------- |-----------|--------|----|--- | |id| id | path | true |integer | | **响应示例**: ```json { "code": 0, "message": "", "obj": {} } ``` **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | ------------ | -------------------|-------|----------- | |code| |integer(int64) | integer(int64) | |message| |string | | |obj| |object | | **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK |RespBean| | 204 | No Content || | 401 | Unauthorized || | 403 | Forbidden || # 验证码controller ## 验证码 **接口描述**: **接口地址**:`/captcha` **请求方式**:`GET` **consumes**:`` **produces**:`["*/*","image/jpeg"]` **请求参数**: 暂无 **响应示例**: ```json ``` **响应参数**: 暂无 **响应状态**: | 状态码 | 说明 | schema | | ------------ | -------------------------------- |---------------------- | | 200 | OK || | 401 | Unauthorized || | 403 | Forbidden || | 404 | Not Found ||