docs: 同步部门管理模块文档
更新内容:
1. API接口文档.md
- 新增「二、部门管理接口」章节(229行)
- 6个核心接口文档:
* 2.1 获取部门树(树形结构)
* 2.2 获取部门列表(扁平结构)
* 2.3 获取部门详情
* 2.4 新增部门
* 2.5 更新部门
* 2.6 删除部门
- 完整的请求参数、响应示例、字段说明
- 部门层级结构展示(children嵌套)
- 调整后续所有章节编号(三~十三)
2. 资金服务平台 FundPlatform 功能清单.md
- 标记「4.1.2 组织架构管理」为已完成 ✅
- 标记「部门管理(增删改查、层级关系)」为已完成 ✅
- 添加实现状态说明:
* 后端:DeptMapper + DeptService + DeptController
* 前端:dept.js + dept.vue
* 功能清单:10大功能点
* 树形结构展示
* 层级管理、负责人管理、状态管理
文档与代码同步完成!
注意:部门管理的前后端代码早期已完成,本次仅补充文档同步。
This commit is contained in:
parent
c115a0b58c
commit
39577a9b11
250
doc/API接口文档.md
250
doc/API接口文档.md
@ -145,9 +145,235 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 二、认证接口
|
## 二、部门管理接口
|
||||||
|
|
||||||
### 2.1 用户登录
|
### 2.1 获取部门树
|
||||||
|
|
||||||
|
**接口地址:** `GET /api/v1/dept/tree`
|
||||||
|
|
||||||
|
**接口说明:** 获取部门树形结构(含层级关系)
|
||||||
|
|
||||||
|
**请求参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 必填 | 说明 |
|
||||||
|
|--------|------|------|------|
|
||||||
|
| tenantId | Long | 否 | 租户ID(不传则使用默认租户) |
|
||||||
|
|
||||||
|
**响应示例:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"message": "操作成功",
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"deptId": 1,
|
||||||
|
"tenantId": 1,
|
||||||
|
"deptName": "万家布洛科技",
|
||||||
|
"parentId": 0,
|
||||||
|
"deptCode": "ROOT",
|
||||||
|
"deptLevel": 1,
|
||||||
|
"sortOrder": 1,
|
||||||
|
"leader": "张三",
|
||||||
|
"leaderPhone": "13800138000",
|
||||||
|
"status": 1,
|
||||||
|
"remark": "总公司",
|
||||||
|
"children": [
|
||||||
|
{
|
||||||
|
"deptId": 2,
|
||||||
|
"deptName": "技术部",
|
||||||
|
"parentId": 1,
|
||||||
|
"deptCode": "TECH",
|
||||||
|
"deptLevel": 2,
|
||||||
|
"sortOrder": 1,
|
||||||
|
"leader": "李四",
|
||||||
|
"leaderPhone": "13900139000",
|
||||||
|
"status": 1,
|
||||||
|
"children": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2.2 获取部门列表
|
||||||
|
|
||||||
|
**接口地址:** `GET /api/v1/dept/list`
|
||||||
|
|
||||||
|
**接口说明:** 获取部门列表(扁平结构)
|
||||||
|
|
||||||
|
**请求参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 必填 | 说明 |
|
||||||
|
|--------|------|------|------|
|
||||||
|
| tenantId | Long | 否 | 租户ID(不传则使用默认租户) |
|
||||||
|
|
||||||
|
**响应示例:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"message": "操作成功",
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"deptId": 1,
|
||||||
|
"tenantId": 1,
|
||||||
|
"deptName": "万家布洛科技",
|
||||||
|
"parentId": 0,
|
||||||
|
"deptCode": "ROOT",
|
||||||
|
"deptLevel": 1,
|
||||||
|
"sortOrder": 1,
|
||||||
|
"leader": "张三",
|
||||||
|
"leaderPhone": "13800138000",
|
||||||
|
"status": 1,
|
||||||
|
"remark": "总公司"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2.3 获取部门详情
|
||||||
|
|
||||||
|
**接口地址:** `GET /api/v1/dept/{deptId}`
|
||||||
|
|
||||||
|
**接口说明:** 根据ID查询部门详情
|
||||||
|
|
||||||
|
**路径参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 必填 | 说明 |
|
||||||
|
|--------|------|------|------|
|
||||||
|
| deptId | Long | 是 | 部门ID |
|
||||||
|
|
||||||
|
**响应示例:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"message": "操作成功",
|
||||||
|
"data": {
|
||||||
|
"deptId": 1,
|
||||||
|
"tenantId": 1,
|
||||||
|
"deptName": "万家布洛科技",
|
||||||
|
"parentId": 0,
|
||||||
|
"deptCode": "ROOT",
|
||||||
|
"deptLevel": 1,
|
||||||
|
"sortOrder": 1,
|
||||||
|
"leader": "张三",
|
||||||
|
"leaderPhone": "13800138000",
|
||||||
|
"status": 1,
|
||||||
|
"remark": "总公司",
|
||||||
|
"createdTime": "2026-01-01 10:00:00"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2.4 新增部门
|
||||||
|
|
||||||
|
**接口地址:** `POST /api/v1/dept`
|
||||||
|
|
||||||
|
**接口说明:** 创建新部门
|
||||||
|
|
||||||
|
**请求参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 必填 | 说明 |
|
||||||
|
|--------|------|------|------|
|
||||||
|
| deptName | String | 是 | 部门名称 |
|
||||||
|
| parentId | Long | 是 | 父部门ID(顶级部门为0) |
|
||||||
|
| deptCode | String | 否 | 部门编码 |
|
||||||
|
| deptLevel | Integer | 否 | 部门层级(系统自动计算) |
|
||||||
|
| sortOrder | Integer | 否 | 排序号 |
|
||||||
|
| leader | String | 否 | 负责人 |
|
||||||
|
| leaderPhone | String | 否 | 负责人电话 |
|
||||||
|
| status | Integer | 否 | 状态(0-禁用,1-启用,默认1) |
|
||||||
|
| remark | String | 否 | 备注 |
|
||||||
|
|
||||||
|
**请求示例:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"deptName": "技术部",
|
||||||
|
"parentId": 1,
|
||||||
|
"deptCode": "TECH",
|
||||||
|
"sortOrder": 1,
|
||||||
|
"leader": "李四",
|
||||||
|
"leaderPhone": "13900139000",
|
||||||
|
"status": 1,
|
||||||
|
"remark": "技术研发部门"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**响应示例:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"message": "创建成功",
|
||||||
|
"data": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2.5 更新部门
|
||||||
|
|
||||||
|
**接口地址:** `PUT /api/v1/dept/{deptId}`
|
||||||
|
|
||||||
|
**接口说明:** 更新部门信息
|
||||||
|
|
||||||
|
**路径参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 必填 | 说明 |
|
||||||
|
|--------|------|------|------|
|
||||||
|
| deptId | Long | 是 | 部门ID |
|
||||||
|
|
||||||
|
**请求参数:** 同2.4
|
||||||
|
|
||||||
|
**响应示例:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"message": "更新成功",
|
||||||
|
"data": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2.6 删除部门
|
||||||
|
|
||||||
|
**接口地址:** `DELETE /api/v1/dept/{deptId}`
|
||||||
|
|
||||||
|
**接口说明:** 删除指定部门(若有子部门则无法删除)
|
||||||
|
|
||||||
|
**路径参数:**
|
||||||
|
|
||||||
|
| 参数名 | 类型 | 必填 | 说明 |
|
||||||
|
|--------|------|------|------|
|
||||||
|
| deptId | Long | 是 | 部门ID |
|
||||||
|
|
||||||
|
**响应示例:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"message": "删除成功",
|
||||||
|
"data": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 三、认证接口
|
||||||
|
|
||||||
|
### 3.1 用户登录
|
||||||
|
|
||||||
**接口地址:** `POST /api/v1/auth/login`
|
**接口地址:** `POST /api/v1/auth/login`
|
||||||
|
|
||||||
@ -305,7 +531,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 三、用户管理接口
|
## 四、用户管理接口
|
||||||
|
|
||||||
### 3.1 获取用户列表
|
### 3.1 获取用户列表
|
||||||
|
|
||||||
@ -503,7 +729,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 四、租户管理接口
|
## 五、租户管理接口
|
||||||
|
|
||||||
### 4.1 获取租户列表
|
### 4.1 获取租户列表
|
||||||
|
|
||||||
@ -567,7 +793,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 五、客户管理接口
|
## 六、客户管理接口
|
||||||
|
|
||||||
### 5.1 获取客户列表
|
### 5.1 获取客户列表
|
||||||
|
|
||||||
@ -666,7 +892,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 六、项目管理接口
|
## 七、项目管理接口
|
||||||
|
|
||||||
### 6.1 获取项目列表
|
### 6.1 获取项目列表
|
||||||
|
|
||||||
@ -971,7 +1197,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 七、需求工单接口
|
## 八、需求工单接口
|
||||||
|
|
||||||
### 7.1 获取需求列表
|
### 7.1 获取需求列表
|
||||||
|
|
||||||
@ -1040,7 +1266,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 八、支出管理接口
|
## 九、支出管理接口
|
||||||
|
|
||||||
### 8.1 获取支出类型列表
|
### 8.1 获取支出类型列表
|
||||||
|
|
||||||
@ -1106,7 +1332,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 九、应收款管理接口
|
## 十、应收款管理接口
|
||||||
|
|
||||||
### 9.1 获取应收款列表
|
### 9.1 获取应收款列表
|
||||||
|
|
||||||
@ -1180,7 +1406,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 十、收款记录管理接口
|
## 十一、收款记录管理接口
|
||||||
|
|
||||||
### 10.1 获取收款记录列表
|
### 10.1 获取收款记录列表
|
||||||
|
|
||||||
@ -1368,7 +1594,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 十一、操作日志管理接口
|
## 十二、操作日志管理接口
|
||||||
|
|
||||||
### 11.1 获取操作日志列表
|
### 11.1 获取操作日志列表
|
||||||
|
|
||||||
@ -1530,7 +1756,7 @@ X-Tenant-Id: 1
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 十二、附录
|
## 十三、附录
|
||||||
|
|
||||||
### 12.1 枚举值定义
|
### 12.1 枚举值定义
|
||||||
|
|
||||||
|
|||||||
@ -19,8 +19,22 @@
|
|||||||
* 执行时长监控(超时标红>1000ms)
|
* 执行时长监控(超时标红>1000ms)
|
||||||
* 状态展示(成功/失败)
|
* 状态展示(成功/失败)
|
||||||
|
|
||||||
#### 4.1.2 组织架构管理
|
#### 4.1.2 组织架构管理 ✅
|
||||||
- 部门管理(增删改查、层级关系)
|
- 部门管理(增删改查、层级关系) ✅
|
||||||
|
- **实现状态**:✅ 已完成
|
||||||
|
- 后端:DeptMapper + DeptService + DeptController
|
||||||
|
- 前端:dept.js + dept.vue
|
||||||
|
- 功能:
|
||||||
|
* 获取部门树(树形结构展示)
|
||||||
|
* 获取部门列表(扁平结构)
|
||||||
|
* 查询部门详情
|
||||||
|
* 新增部门(支持顶级部门和子部门)
|
||||||
|
* 更新部门信息
|
||||||
|
* 删除部门(含子部门校验)
|
||||||
|
* 部门层级管理(自动计算层级)
|
||||||
|
* 负责人管理(姓名+电话)
|
||||||
|
* 状态管理(启用/禁用)
|
||||||
|
* 排序功能
|
||||||
- 岗位管理(岗位定义、职责描述)
|
- 岗位管理(岗位定义、职责描述)
|
||||||
- 人员分配(部门人员配置)
|
- 人员分配(部门人员配置)
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user