init
This commit is contained in:
王鹏
78
RuoYi-Vue/docs/SysCodeSnippetController.md
Normal file
78
RuoYi-Vue/docs/SysCodeSnippetController.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# API Documentation for SysCodeSnippetController
|
||||
|
||||
This document provides details about the API endpoints managed by `SysCodeSnippetController`.
|
||||
|
||||
## Base Path: `/generator/snippet`
|
||||
|
||||
---
|
||||
|
||||
### 1. List Code Snippets
|
||||
|
||||
* **Description:** Retrieves a paginated list of code snippets.
|
||||
* **Endpoint:** `GET /list`
|
||||
* **Permissions:** `generator:snippet:list`
|
||||
* **Request Parameters:**
|
||||
* `SysCodeSnippet` object (passed as query parameters) - Used for filtering the list.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `TableDataInfo` containing a list of `SysCodeSnippet` objects.
|
||||
|
||||
---
|
||||
|
||||
### 2. Export Code Snippets
|
||||
|
||||
* **Description:** Exports the list of code snippets to an Excel file.
|
||||
* **Endpoint:** `POST /export`
|
||||
* **Permissions:** `generator:snippet:export`
|
||||
* **Request Parameters:**
|
||||
* `HttpServletResponse` response
|
||||
* `SysCodeSnippet` object (passed as query parameters) - Used for filtering the list to be exported.
|
||||
* **Responses:**
|
||||
* Triggers a file download with the Excel data.
|
||||
|
||||
---
|
||||
|
||||
### 3. Get Code Snippet Details
|
||||
|
||||
* **Description:** Retrieves detailed information about a specific code snippet.
|
||||
* **Endpoint:** `GET /{snippetId}`
|
||||
* **Permissions:** `generator:snippet:query`
|
||||
* **Path Variables:**
|
||||
* `snippetId` (Long): The ID of the code snippet.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` containing the `SysCodeSnippet` object.
|
||||
|
||||
---
|
||||
|
||||
### 4. Add New Code Snippet
|
||||
|
||||
* **Description:** Creates a new code snippet.
|
||||
* **Endpoint:** `POST /`
|
||||
* **Permissions:** `generator:snippet:add`
|
||||
* **Request Body:**
|
||||
* `SysCodeSnippet` object (JSON)
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` indicating success or failure of the operation.
|
||||
|
||||
---
|
||||
|
||||
### 5. Update Code Snippet
|
||||
|
||||
* **Description:** Modifies an existing code snippet.
|
||||
* **Endpoint:** `PUT /`
|
||||
* **Permissions:** `generator:snippet:edit`
|
||||
* **Request Body:**
|
||||
* `SysCodeSnippet` object (JSON)
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` indicating success or failure of the operation.
|
||||
|
||||
---
|
||||
|
||||
### 6. Delete Code Snippet(s)
|
||||
|
||||
* **Description:** Deletes one or more code snippets.
|
||||
* **Endpoint:** `DELETE /{snippetIds}`
|
||||
* **Permissions:** `generator:snippet:remove`
|
||||
* **Path Variables:**
|
||||
* `snippetIds` (Long[]): An array of IDs of the code snippets to be deleted.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` indicating success or failure of the operation.
|
||||
141
RuoYi-Vue/docs/SysModuleControllerApi.md
Normal file
141
RuoYi-Vue/docs/SysModuleControllerApi.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# SysModuleController API Documentation
|
||||
|
||||
This document outlines the API endpoints provided by the `SysModuleController`.
|
||||
|
||||
## Base Path
|
||||
`/generator/module`
|
||||
|
||||
## Endpoints
|
||||
|
||||
### 1. 查询功能模块列表 (List Functional Modules)
|
||||
- **Description**: Retrieves a paginated list of functional modules.
|
||||
- **Permissions**: `generator:module:list`
|
||||
- **HTTP Method**: `GET`
|
||||
- **Endpoint**: `/list`
|
||||
- **Request Parameters**:
|
||||
- `sysModule` (Query Parameters): An object of `SysModule` containing filter criteria.
|
||||
- `moduleId` (Long): Module ID
|
||||
- `moduleName` (String): Module Name
|
||||
- `moduleCode` (String): Module Code
|
||||
- `moduleDesc` (String): Module Description
|
||||
- `status` (String): Status (e.g., '0' for normal, '1' for disabled)
|
||||
- `createBy` (String): Creator
|
||||
- `createTime` (Date): Creation Time
|
||||
- `updateBy` (String): Updater
|
||||
- `updateTime` (Date): Update Time
|
||||
- `remark` (String): Remarks
|
||||
- **Responses**:
|
||||
- `200 OK`: `TableDataInfo` containing a list of `SysModule` objects.
|
||||
```json
|
||||
{
|
||||
"total": 100,
|
||||
"rows": [
|
||||
{
|
||||
"moduleId": 1,
|
||||
"moduleName": "Sample Module",
|
||||
"moduleCode": "sample",
|
||||
// ... other SysModule fields
|
||||
}
|
||||
],
|
||||
"code": 200,
|
||||
"msg": "查询成功"
|
||||
}
|
||||
```
|
||||
|
||||
### 2. 导出功能模块列表 (Export Functional Modules)
|
||||
- **Description**: Exports the list of functional modules to an Excel file.
|
||||
- **Permissions**: `generator:module:export`
|
||||
- **HTTP Method**: `POST`
|
||||
- **Endpoint**: `/export`
|
||||
- **Request Parameters**:
|
||||
- `sysModule` (Request Body): An object of `SysModule` containing filter criteria. (Same as list endpoint)
|
||||
- **Responses**:
|
||||
- `200 OK`: An Excel file download.
|
||||
|
||||
### 3. 获取功能模块详细信息 (Get Functional Module Details)
|
||||
- **Description**: Retrieves detailed information about a specific functional module by its ID.
|
||||
- **Permissions**: `generator:module:query`
|
||||
- **HTTP Method**: `GET`
|
||||
- **Endpoint**: `/{moduleId}`
|
||||
- **Path Variables**:
|
||||
- `moduleId` (Long): The ID of the functional module.
|
||||
- **Responses**:
|
||||
- `200 OK`: `AjaxResult` containing the `SysModule` object.
|
||||
```json
|
||||
{
|
||||
"msg": "操作成功",
|
||||
"code": 200,
|
||||
"data": {
|
||||
"moduleId": 1,
|
||||
"moduleName": "Sample Module",
|
||||
"moduleCode": "sample",
|
||||
// ... other SysModule fields
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. 新增功能模块 (Add Functional Module)
|
||||
- **Description**: Creates a new functional module.
|
||||
- **Permissions**: `generator:module:add`
|
||||
- **HTTP Method**: `POST`
|
||||
- **Endpoint**: `/`
|
||||
- **Request Body**:
|
||||
- `sysModule` (`SysModule`): The functional module object to create.
|
||||
```json
|
||||
{
|
||||
"moduleName": "New Module",
|
||||
"moduleCode": "new_module",
|
||||
"moduleDesc": "Description of new module",
|
||||
"status": "0"
|
||||
// ... other SysModule fields (moduleId is auto-generated)
|
||||
}
|
||||
```
|
||||
- **Responses**:
|
||||
- `200 OK`: `AjaxResult` indicating success or failure.
|
||||
```json
|
||||
{
|
||||
"msg": "操作成功", // or error message
|
||||
"code": 200, // or error code
|
||||
"data": null // or generated ID (implementation dependent)
|
||||
}
|
||||
```
|
||||
|
||||
### 5. 修改功能模块 (Update Functional Module)
|
||||
- **Description**: Updates an existing functional module.
|
||||
- **Permissions**: `generator:module:edit`
|
||||
- **HTTP Method**: `PUT`
|
||||
- **Endpoint**: `/`
|
||||
- **Request Body**:
|
||||
- `sysModule` (`SysModule`): The functional module object to update. Must include `moduleId`.
|
||||
```json
|
||||
{
|
||||
"moduleId": 1,
|
||||
"moduleName": "Updated Module Name",
|
||||
"moduleCode": "updated_module_code",
|
||||
// ... other SysModule fields to update
|
||||
}
|
||||
```
|
||||
- **Responses**:
|
||||
- `200 OK`: `AjaxResult` indicating success or failure.
|
||||
```json
|
||||
{
|
||||
"msg": "操作成功", // or error message
|
||||
"code": 200 // or error code
|
||||
}
|
||||
```
|
||||
|
||||
### 6. 删除功能模块 (Delete Functional Module)
|
||||
- **Description**: Deletes one or more functional modules by their IDs.
|
||||
- **Permissions**: `generator:module:remove`
|
||||
- **HTTP Method**: `DELETE`
|
||||
- **Endpoint**: `/{moduleIds}`
|
||||
- **Path Variables**:
|
||||
- `moduleIds` (Long[]): An array of functional module IDs to delete (e.g., `/1,2,3`).
|
||||
- **Responses**:
|
||||
- `200 OK`: `AjaxResult` indicating success or failure.
|
||||
```json
|
||||
{
|
||||
"msg": "操作成功", // or error message
|
||||
"code": 200 // or error code
|
||||
}
|
||||
```
|
||||
174
RuoYi-Vue/docs/SysProjectModuleControllerApi.md
Normal file
174
RuoYi-Vue/docs/SysProjectModuleControllerApi.md
Normal file
@@ -0,0 +1,174 @@
|
||||
# API Documentation: SysProjectModuleController
|
||||
|
||||
Base Path: `/generator/project/module`
|
||||
|
||||
---
|
||||
|
||||
## 1. 查询功能模块与项目关系列表
|
||||
|
||||
- **Description**: Retrieves a paginated list of project-module relationships.
|
||||
- **HTTP Method**: `GET`
|
||||
- **Path**: `/list`
|
||||
- **Permissions**: `generator:module:list`
|
||||
- **Query Parameters**:
|
||||
- Fields from `SysProjectModule` object can be used as query parameters for filtering. (e.g., `projectId`, `moduleId`)
|
||||
- **Success Response**:
|
||||
- **Code**: `200 OK`
|
||||
- **Content**: `TableDataInfo`
|
||||
```json
|
||||
{
|
||||
"total": 100, // Total number of records
|
||||
"rows": [ // List of SysProjectModule objects
|
||||
{
|
||||
"id": 1,
|
||||
"projectId": 10,
|
||||
"moduleId": 20,
|
||||
// ... other fields of SysProjectModule
|
||||
}
|
||||
],
|
||||
"code": 200, // HTTP status code or custom success code
|
||||
"msg": "查询成功" // Success message
|
||||
}
|
||||
```
|
||||
- **Error Response**:
|
||||
- Standard error responses.
|
||||
|
||||
---
|
||||
|
||||
## 2. 导出功能模块与项目关系列表
|
||||
|
||||
- **Description**: Exports the list of project-module relationships as an Excel file.
|
||||
- **Log**: `title = "功能模块与项目关系", businessType = BusinessType.EXPORT`
|
||||
- **HTTP Method**: `POST`
|
||||
- **Path**: `/export`
|
||||
- **Permissions**: `generator:module:export`
|
||||
- **Query Parameters**:
|
||||
- Fields from `SysProjectModule` object can be used as query parameters for filtering the data to be exported.
|
||||
- **Success Response**:
|
||||
- **Code**: `200 OK`
|
||||
- **Content**: Excel file (`功能模块与项目关系数据.xlsx`)
|
||||
- **Error Response**:
|
||||
- Standard error responses.
|
||||
|
||||
---
|
||||
|
||||
## 3. 获取功能模块与项目关系详细信息
|
||||
|
||||
- **Description**: Retrieves detailed information about a specific project-module relationship by its ID.
|
||||
- **HTTP Method**: `GET`
|
||||
- **Path**: `/{id}`
|
||||
- **Permissions**: `generator:module:query`
|
||||
- **Path Parameters**:
|
||||
- `id` (Long, required): The ID of the project-module relationship.
|
||||
- **Success Response**:
|
||||
- **Code**: `200 OK`
|
||||
- **Content**: `AjaxResult`
|
||||
```json
|
||||
{
|
||||
"code": 200, // HTTP status code or custom success code
|
||||
"msg": "操作成功",
|
||||
"data": { // SysProjectModule object
|
||||
"id": 1,
|
||||
"projectId": 10,
|
||||
"moduleId": 20,
|
||||
// ... other fields of SysProjectModule
|
||||
}
|
||||
}
|
||||
```
|
||||
- **Error Response**:
|
||||
- Standard error responses (e.g., 404 Not Found if ID does not exist).
|
||||
|
||||
---
|
||||
|
||||
## 4. 新增功能模块与项目关系
|
||||
|
||||
- **Description**: Creates a new project-module relationship.
|
||||
- **Log**: `title = "功能模块与项目关系", businessType = BusinessType.INSERT`
|
||||
- **HTTP Method**: `POST`
|
||||
- **Path**: `/`
|
||||
- **Permissions**: `generator:module:add`
|
||||
- **Request Body**:
|
||||
- **Content-Type**: `application/json`
|
||||
- **Schema**: `SysProjectModule`
|
||||
```json
|
||||
{
|
||||
"projectId": 10,
|
||||
"moduleId": 20,
|
||||
// ... other required fields of SysProjectModule
|
||||
}
|
||||
```
|
||||
- **Success Response**:
|
||||
- **Code**: `200 OK`
|
||||
- **Content**: `AjaxResult`
|
||||
```json
|
||||
{
|
||||
"code": 200, // HTTP status code or custom success code
|
||||
"msg": "操作成功",
|
||||
"data": null // Or the ID of the newly created entity
|
||||
}
|
||||
```
|
||||
- **Error Response**:
|
||||
- Standard error responses (e.g., 400 Bad Request for validation errors).
|
||||
|
||||
---
|
||||
|
||||
## 5. 修改功能模块与项目关系
|
||||
|
||||
- **Description**: Updates an existing project-module relationship.
|
||||
- **Log**: `title = "功能模块与项目关系", businessType = BusinessType.UPDATE`
|
||||
- **HTTP Method**: `PUT`
|
||||
- **Path**: `/`
|
||||
- **Permissions**: `generator:module:edit`
|
||||
- **Request Body**:
|
||||
- **Content-Type**: `application/json`
|
||||
- **Schema**: `SysProjectModule` (must include the `id` of the entity to update)
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"projectId": 11,
|
||||
"moduleId": 22,
|
||||
// ... other fields of SysProjectModule to update
|
||||
}
|
||||
```
|
||||
- **Success Response**:
|
||||
- **Code**: `200 OK`
|
||||
- **Content**: `AjaxResult`
|
||||
```json
|
||||
{
|
||||
"code": 200, // HTTP status code or custom success code
|
||||
"msg": "操作成功",
|
||||
"data": null
|
||||
}
|
||||
```
|
||||
- **Error Response**:
|
||||
- Standard error responses (e.g., 400 Bad Request, 404 Not Found).
|
||||
|
||||
---
|
||||
|
||||
## 6. 删除功能模块与项目关系
|
||||
|
||||
- **Description**: Deletes one or more project-module relationships by their IDs.
|
||||
- **Log**: `title = "功能模块与项目关系", businessType = BusinessType.DELETE`
|
||||
- **HTTP Method**: `DELETE`
|
||||
- **Path**: `/{ids}`
|
||||
- **Permissions**: `generator:module:remove`
|
||||
- **Path Parameters**:
|
||||
- `ids` (Long[], required): An array of IDs of the project-module relationships to delete. (e.g., `/1,2,3`)
|
||||
- **Success Response**:
|
||||
- **Code**: `200 OK`
|
||||
- **Content**: `AjaxResult`
|
||||
```json
|
||||
{
|
||||
"code": 200, // HTTP status code or custom success code
|
||||
"msg": "操作成功",
|
||||
"data": null
|
||||
}
|
||||
```
|
||||
- **Error Response**:
|
||||
- Standard error responses (e.g., 404 Not Found).
|
||||
|
||||
---
|
||||
**Note**:
|
||||
- `SysProjectModule`: Refers to the `com.ruoyi.generator.domain.SysProjectModule` class. The exact fields would need to be looked up from its definition.
|
||||
- `TableDataInfo`: A common wrapper for paginated list responses, typically including `total` (total records), `rows` (current page data), `code` (status), and `msg` (message).
|
||||
- `AjaxResult`: A common wrapper for API responses, typically including `code` (status), `msg` (message), and `data` (the actual response payload).
|
||||
72
RuoYi-Vue/docs/SysProjectStructureAPI.md
Normal file
72
RuoYi-Vue/docs/SysProjectStructureAPI.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# 项目结构节点 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文件供下载
|
||||
212
RuoYi-Vue/docs/SysProjectTemplateController.md
Normal file
212
RuoYi-Vue/docs/SysProjectTemplateController.md
Normal file
@@ -0,0 +1,212 @@
|
||||
# 项目模板配置接口文档
|
||||
|
||||
该文档描述了项目模板配置相关的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": "操作成功"
|
||||
}
|
||||
```
|
||||
98
RuoYi-Vue/docs/TemplateFileController.md
Normal file
98
RuoYi-Vue/docs/TemplateFileController.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# API Documentation for TemplateFileController
|
||||
|
||||
This document provides details about the API endpoints exposed by the `TemplateFileController`.
|
||||
|
||||
## Base Path: `/generator/templateFile`
|
||||
|
||||
---
|
||||
|
||||
### 1. Query Code Template File List
|
||||
|
||||
* **HTTP Method:** `GET`
|
||||
* **Path:** `/list`
|
||||
* **Permissions:** `generator:template:list`
|
||||
* **Description:** Retrieves a paginated list of code template files.
|
||||
* **Request Parameters:**
|
||||
* `templateFile` (Query Param, `TemplateFile` object): Object containing filter criteria for template files.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `TableDataInfo` containing a list of `TemplateFile` objects.
|
||||
|
||||
---
|
||||
|
||||
### 2. Query Code Template File List by Template ID
|
||||
|
||||
* **HTTP Method:** `GET`
|
||||
* **Path:** `/listByTemplateId/{templateId}`
|
||||
* **Permissions:** `generator:template:list`
|
||||
* **Description:** Retrieves a paginated list of code template files for a specific template ID.
|
||||
* **Path Variables:**
|
||||
* `templateId` (Long): The ID of the template.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `TableDataInfo` containing a list of `TemplateFile` objects.
|
||||
|
||||
---
|
||||
|
||||
### 3. Get Code Template File Details
|
||||
|
||||
* **HTTP Method:** `GET`
|
||||
* **Path:** `/{templateFileId}`
|
||||
* **Permissions:** `generator:template:query`
|
||||
* **Description:** Retrieves detailed information about a specific code template file.
|
||||
* **Path Variables:**
|
||||
* `templateFileId` (Long): The ID of the code template file.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` containing the `TemplateFile` object.
|
||||
|
||||
---
|
||||
|
||||
### 4. Add New Code Template File
|
||||
|
||||
* **HTTP Method:** `POST`
|
||||
* **Path:** `/`
|
||||
* **Permissions:** `generator:template:add`
|
||||
* **Description:** Creates a new code template file.
|
||||
* **Request Body:**
|
||||
* `templateFile` (`TemplateFile` object, validated): The code template file data to be created.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` indicating the success or failure of the operation.
|
||||
|
||||
---
|
||||
|
||||
### 5. Modify Code Template File
|
||||
|
||||
* **HTTP Method:** `PUT`
|
||||
* **Path:** `/`
|
||||
* **Permissions:** `generator:template:edit`
|
||||
* **Description:** Updates an existing code template file.
|
||||
* **Request Body:**
|
||||
* `templateFile` (`TemplateFile` object, validated): The code template file data to be updated.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` indicating the success or failure of the operation.
|
||||
|
||||
---
|
||||
|
||||
### 6. Delete Code Template File(s)
|
||||
|
||||
* **HTTP Method:** `DELETE`
|
||||
* **Path:** `/{templateFileIds}`
|
||||
* **Permissions:** `generator:template:remove`
|
||||
* **Description:** Deletes one or more code template files by their IDs.
|
||||
* **Path Variables:**
|
||||
* `templateFileIds` (Array of Long): An array of code template file IDs to be deleted.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` indicating the success or failure of the operation.
|
||||
|
||||
---
|
||||
|
||||
### 7. Delete Code Template Files by Template ID
|
||||
|
||||
* **HTTP Method:** `DELETE`
|
||||
* **Path:** `/deleteByTemplateId/{templateId}`
|
||||
* **Permissions:** `generator:template:remove`
|
||||
* **Description:** Deletes all code template files associated with a specific template ID.
|
||||
* **Path Variables:**
|
||||
* `templateId` (Long): The ID of the template whose files are to be deleted.
|
||||
* **Responses:**
|
||||
* `200 OK`: Returns `AjaxResult` indicating the success or failure of the operation.
|
||||
|
||||
---
|
||||
97
RuoYi-Vue/docs/template_controller_api.md
Normal file
97
RuoYi-Vue/docs/template_controller_api.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# TemplateController API Documentation
|
||||
|
||||
Base Path: `/generator/template`
|
||||
|
||||
## Endpoints
|
||||
|
||||
### 1. 查询代码模版列表 (Query code template list)
|
||||
|
||||
* **Method:** `GET`
|
||||
* **Path:** `/list`
|
||||
* **Permissions:** `generator:template:list`
|
||||
* **Description:** Retrieves a paginated list of code templates.
|
||||
* **Request Parameters:**
|
||||
* `Template` object (sent as query parameters). Refer to the `Template` domain class for available fields.
|
||||
* **Responses:**
|
||||
* `200 OK`: `TableDataInfo` containing the list of templates and pagination information.
|
||||
|
||||
### 2. 导出代码模版列表 (Export code template list)
|
||||
|
||||
* **Method:** `POST`
|
||||
* **Path:** `/export`
|
||||
* **Permissions:** `generator:template:export`
|
||||
* **Description:** Exports the list of code templates as an Excel file.
|
||||
* **Request Parameters:**
|
||||
* `Template` object (sent as query parameters). Refer to the `Template` domain class for available fields.
|
||||
* **Responses:**
|
||||
* `200 OK`: Excel file download.
|
||||
|
||||
### 3. 获取代码模版详细信息 (Get code template details)
|
||||
|
||||
* **Method:** `GET`
|
||||
* **Path:** `/{templateId}`
|
||||
* **Permissions:** `generator:template:query`
|
||||
* **Description:** Retrieves detailed information about a specific code template.
|
||||
* **Path Variables:**
|
||||
* `templateId` (Long): The ID of the template.
|
||||
* **Responses:**
|
||||
* `200 OK`: `AjaxResult` containing the `Template` object.
|
||||
* `404 Not Found`: If the template with the given ID does not exist.
|
||||
|
||||
### 4. 新增代码模版 (Add new code template)
|
||||
|
||||
* **Method:** `POST`
|
||||
* **Path:** `/`
|
||||
* **Permissions:** `generator:template:add`
|
||||
* **Description:** Creates a new code template.
|
||||
* **Request Body:**
|
||||
* `Template` object (JSON). Refer to the `Template` domain class for required and optional fields.
|
||||
* **Responses:**
|
||||
* `200 OK`: `AjaxResult` indicating success or failure.
|
||||
|
||||
### 5. 修改代码模版 (Modify code template)
|
||||
|
||||
* **Method:** `PUT`
|
||||
* **Path:** `/`
|
||||
* **Permissions:** `generator:template:edit`
|
||||
* **Description:** Updates an existing code template.
|
||||
* **Request Body:**
|
||||
* `Template` object (JSON). `templateId` must be provided. Refer to the `Template` domain class for updatable fields.
|
||||
* **Responses:**
|
||||
* `200 OK`: `AjaxResult` indicating success or failure.
|
||||
* `404 Not Found`: If the template with the given ID does not exist.
|
||||
|
||||
### 6. 删除代码模版 (Delete code template)
|
||||
|
||||
* **Method:** `DELETE`
|
||||
* **Path:** `/{templateIds}`
|
||||
* **Permissions:** `generator:template:remove`
|
||||
* **Description:** Deletes one or more code templates.
|
||||
* **Path Variables:**
|
||||
* `templateIds` (Long[]): An array of template IDs to delete.
|
||||
* **Responses:**
|
||||
* `200 OK`: `AjaxResult` indicating success or failure.
|
||||
|
||||
### 7. 修改模版状态 (Modify template status)
|
||||
|
||||
* **Method:** `PUT`
|
||||
* **Path:** `/changeStatus`
|
||||
* **Permissions:** `generator:template:edit`
|
||||
* **Description:** Modifies the status of a code template (e.g., enable/disable).
|
||||
* **Request Body:**
|
||||
* `Template` object (JSON). Should include `templateId` and the new `status`.
|
||||
* **Responses:**
|
||||
* `200 OK`: `AjaxResult` indicating success or failure.
|
||||
* `404 Not Found`: If the template with the given ID does not exist.
|
||||
|
||||
## `Template` Domain Object (for reference)
|
||||
|
||||
(Please refer to `com.ruoyi.generator.domain.Template` for the exact structure and fields. Key fields likely include `templateId`, `templateName`, `content`, `status`, etc.)
|
||||
|
||||
## `TableDataInfo` Object (for reference)
|
||||
|
||||
(Standard RuoYi object for paginated list responses. Typically includes `total`, `rows`, `code`, `msg`.)
|
||||
|
||||
## `AjaxResult` Object (for reference)
|
||||
|
||||
(Standard RuoYi object for API responses. Typically includes `code`, `msg`, `data`.)
|
||||
Reference in New Issue
Block a user