54 lines
2.0 KiB
Markdown
54 lines
2.0 KiB
Markdown
# 10.3 Web 管理界面
|
||
|
||
:::tip 概述
|
||
生成器 Web 界面（`tool/generator`）提供可视化操作：浏览数据库表、预览产物代码、勾选生成。与 CLI 共享生成引擎与覆盖策略，权限码 `sys:generator:*` 保护。
|
||
:::
|
||
|
||
## 接口清单
|
||
|
||
| 方法 | 路径 | 权限码 | 说明 |
|
||
|---|---|---|---|
|
||
| GET | /api/generator/page | sys:generator:page | 查询数据表（表名/注释模糊） |
|
||
| POST | /api/generator/preview | sys:generator:generator | 预览选中表的产物代码 |
|
||
| POST | /api/generator/generate | sys:generator:generator | 一键生成 |
|
||
| POST | /api/generator/batchGenerate | sys:generator:batchGenerator | 批量生成 |
|
||
|
||
## 表列表信息
|
||
|
||
Page 接口返回表元信息：表名、注释、存储引擎、记录数、数据大小、自增当前值、排序规则——生成前即可评估表规模与编码。
|
||
|
||
## 操作流
|
||
|
||
```text
|
||
① 表列表搜索定位 → 勾选目标表
|
||
② 预览（Preview）：左侧文件树 + 右侧代码（生成内容所见即所得）
|
||
③ 一键生成（Generate/BatchGenerate）
|
||
④ 查看结果面板：generated / skipped / overwritten / failed
|
||
+ 菜单创建结果 + 字典初始化结果 + 路由声明结果
|
||
```
|
||
|
||
## 生成结果面板
|
||
|
||
```json
|
||
{
|
||
"generated": ["新生成的文件..."],
|
||
"skipped": ["已存在且策略为跳过的文件..."],
|
||
"overwritten": ["覆盖的文件..."],
|
||
"failed": ["失败的文件..."],
|
||
"menu": { "success": true, "menuId": 190, "message": "..." },
|
||
"dict": [ { "dict": "order_status", "items": 2, "status": "created" } ],
|
||
"route": { "success": true, "message": "..." }
|
||
}
|
||
```
|
||
|
||
## 使用建议
|
||
|
||
- 首次生成用**预览**过一遍关键文件（dto 契约、service 声明）
|
||
- 已大量手写的模块不要开 overwrite=true 生成（防冲掉手工调整）
|
||
- 生产环境关闭生成器（`generator.enable=false`，prod 模式强制）
|
||
|
||
## 相关
|
||
|
||
- [10.4 表结构解析与渲染引擎](/zh/generator/code-engine.html)
|
||
- [6.22 示例模块（example）](/zh/modules/example.html)（预览对照物）
|