72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
|
# 项目结构节点 API 文档
|
||
|
|
|
||
|
|
## 接口说明
|
||
|
|
本文档描述了项目结构节点管理相关的所有接口。所有接口都需要相应的权限才能访问。
|
||
|
|
|
||
|
|
## 接口列表
|
||
|
|
|
||
|
|
### 1. 查询项目结构节点列表
|
||
|
|
|
||
|
|
- **接口URL**: `/generator/structure/list`
|
||
|
|
- **请求方式**: GET
|
||
|
|
- **权限要求**: `generator:structure:list`
|
||
|
|
- **请求参数**:
|
||
|
|
- 支持分页查询
|
||
|
|
- 支持按 SysProjectStructure 实体类属性进行条件查询
|
||
|
|
- **响应格式**: TableDataInfo
|
||
|
|
- 包含分页信息和数据列表
|
||
|
|
|
||
|
|
### 2. 导出项目结构节点列表
|
||
|
|
|
||
|
|
- **接口URL**: `/generator/structure/export`
|
||
|
|
- **请求方式**: POST
|
||
|
|
- **权限要求**: `generator:structure:export`
|
||
|
|
- **请求参数**:
|
||
|
|
- SysProjectStructure 实体类属性（用于筛选导出数据）
|
||
|
|
- **响应格式**: Excel文件
|
||
|
|
- 文件名为"项目结构节点数据"
|
||
|
|
|
||
|
|
### 3. 获取项目结构节点详细信息
|
||
|
|
|
||
|
|
- **接口URL**: `/generator/structure/{nodeId}`
|
||
|
|
- **请求方式**: GET
|
||
|
|
- **权限要求**: `generator:structure:query`
|
||
|
|
- **路径参数**:
|
||
|
|
- nodeId: 节点ID
|
||
|
|
- **响应格式**: AjaxResult
|
||
|
|
- 包含节点详细信息
|
||
|
|
|
||
|
|
### 4. 新增项目结构节点
|
||
|
|
|
||
|
|
- **接口URL**: `/generator/structure`
|
||
|
|
- **请求方式**: POST
|
||
|
|
- **权限要求**: `generator:structure:add`
|
||
|
|
- **请求体**: SysProjectStructure 对象
|
||
|
|
- **响应格式**: AjaxResult
|
||
|
|
- 成功/失败状态
|
||
|
|
|
||
|
|
### 5. 修改项目结构节点
|
||
|
|
|
||
|
|
- **接口URL**: `/generator/structure`
|
||
|
|
- **请求方式**: PUT
|
||
|
|
- **权限要求**: `generator:structure:edit`
|
||
|
|
- **请求体**: SysProjectStructure 对象
|
||
|
|
- **响应格式**: AjaxResult
|
||
|
|
- 成功/失败状态
|
||
|
|
|
||
|
|
### 6. 删除项目结构节点
|
||
|
|
|
||
|
|
- **接口URL**: `/generator/structure/{nodeIds}`
|
||
|
|
- **请求方式**: DELETE
|
||
|
|
- **权限要求**: `generator:structure:remove`
|
||
|
|
- **路径参数**:
|
||
|
|
- nodeIds: 节点ID数组
|
||
|
|
- **响应格式**: AjaxResult
|
||
|
|
- 成功/失败状态
|
||
|
|
|
||
|
|
## 注意事项
|
||
|
|
|
||
|
|
1. 所有接口都需要进行权限验证
|
||
|
|
2. 接口返回的 AjaxResult 包含操作状态和消息
|
||
|
|
3. 列表查询接口支持分页功能
|
||
|
|
4. 导出功能会生成Excel文件供下载
|