Files
yidaima/RuoYi-Vue/docs/SysProjectTemplateController.md

212 lines
4.3 KiB
Markdown
Raw Permalink Normal View History

2025-08-14 14:43:47 +08:00
# 项目模板配置接口文档
该文档描述了项目模板配置相关的API接口。
## 基本信息
- **基础路径**: `/generator/project/template`
- **控制器**: `SysProjectTemplateController`
## 接口列表
### 1. 查询项目模板配置列表
- **接口URL**: `/generator/project/template/list`
- **请求方式**: GET
- **权限要求**: `generator:template:list`
- **接口描述**: 分页查询项目模板配置列表
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| 查询条件参数 | SysProjectTemplate | 否 | 项目模板配置查询条件 |
| pageNum | Integer | 否 | 页码 |
| pageSize | Integer | 否 | 每页记录数 |
#### 返回结果
返回TableDataInfo分页数据格式包含项目模板配置列表。
```json
{
"total": 1,
"rows": [
{
"id": 1,
"projectId": 1,
"templateId": 1,
"templateType": "xxx",
...
}
],
"code": 200,
"msg": "查询成功"
}
```
### 2. 根据项目ID查询项目模板配置列表
- **接口URL**: `/generator/project/template/list/{projectId}`
- **请求方式**: GET
- **权限要求**: `generator:template:list`
- **接口描述**: 根据项目ID查询相关的项目模板配置列表
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| projectId | Long | 是 | 项目ID |
#### 返回结果
返回项目模板配置列表。
```json
[
{
"id": 1,
"projectId": 1,
"templateId": 1,
"templateType": "xxx",
...
}
]
```
### 3. 导出项目模板配置列表
- **接口URL**: `/generator/project/template/export`
- **请求方式**: POST
- **权限要求**: `generator:template:export`
- **接口描述**: 导出项目模板配置列表到Excel文件
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| 查询条件参数 | SysProjectTemplate | 否 | 项目模板配置查询条件 |
#### 返回结果
导出Excel文件到浏览器下载。
### 4. 获取项目模板配置详细信息
- **接口URL**: `/generator/project/template/{id}`
- **请求方式**: GET
- **权限要求**: `generator:template:query`
- **接口描述**: 根据ID获取项目模板配置详细信息
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| id | Long | 是 | 项目模板配置ID |
#### 返回结果
```json
{
"code": 200,
"msg": "操作成功",
"data": {
"id": 1,
"projectId": 1,
"templateId": 1,
"templateType": "xxx",
...
}
}
```
### 5. 新增项目模板配置
- **接口URL**: `/generator/project/template`
- **请求方式**: POST
- **权限要求**: `generator:template:add`
- **接口描述**: 新增项目模板配置
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| projectId | Long | 是 | 项目ID |
| templateId | Long | 是 | 模板ID |
| 其他字段 | 类型 | 是/否 | 说明 |
#### 返回结果
```json
{
"code": 200,
"msg": "操作成功"
}
```
### 6. 修改项目模板配置
- **接口URL**: `/generator/project/template`
- **请求方式**: PUT
- **权限要求**: `generator:template:edit`
- **接口描述**: 修改项目模板配置
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| id | Long | 是 | 项目模板配置ID |
| 其他字段 | 类型 | 是/否 | 需要修改的字段 |
#### 返回结果
```json
{
"code": 200,
"msg": "操作成功"
}
```
### 7. 删除项目模板配置
- **接口URL**: `/generator/project/template/{ids}`
- **请求方式**: DELETE
- **权限要求**: `generator:template:remove`
- **接口描述**: 删除项目模板配置
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| ids | Long[] | 是 | 项目模板配置ID数组 |
#### 返回结果
```json
{
"code": 200,
"msg": "操作成功"
}
```
### 8. 根据项目ID删除项目模板配置
- **接口URL**: `/generator/project/template/del/{projectId}`
- **请求方式**: DELETE
- **权限要求**: `generator:template:remove`
- **接口描述**: 根据项目ID删除相关的项目模板配置
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| projectId | Long | 是 | 项目ID |
#### 返回结果
```json
{
"code": 200,
"msg": "操作成功"
}
```