疯狂的狮子Li
127 lines
4.2 KiB
Markdown
127 lines
4.2 KiB
Markdown
# 使用案例
|
||
|
||
## 案例 1：新增标准 CRUD 页面
|
||
|
||
### 用户提问示例
|
||
|
||
```text
|
||
使用 $frontend-crud-coding 为 system/client 补一套前端 CRUD 页面。
|
||
后端接口已经有 /system/client/list、/system/client/{id}、POST /system/client、PUT /system/client、DELETE /system/client/{ids}。
|
||
请参考项目内 gen 模板、src/views/demo/demo/index.vue 和现有 system/client 风格实现。
|
||
```
|
||
|
||
### 期望执行方式
|
||
|
||
- 先看 `src/api/system/client/*` 和 `src/views/system/client/index.vue` 是否已存在。
|
||
- 再看 `src/views/demo/demo/index.vue` 的标准 hooks 版 CRUD 骨架。
|
||
- 对照项目内 `gen/api.ts.vm`、`gen/types.ts.vm`、`gen/index.vue.vm`。
|
||
- 生成或修改 `api/index.ts`、`types.ts`、`views/.../index.vue`。
|
||
- 使用 `AxiosPromise` from `@/utils/api-types`、`PageResult` from `@/api/types`、`useLoading`、`useFormDialog`、`useSearchReset`、`useTableSelection`。
|
||
|
||
## 案例 2：新增树表页面
|
||
|
||
### 用户提问示例
|
||
|
||
```text
|
||
使用 $frontend-crud-coding 为 demo/tree2 新增树表 CRUD，接口返回数组，字段包含 id、parentId、name、orderNum。
|
||
参考 src/views/demo/tree/index.vue 和 workflow/category。
|
||
```
|
||
|
||
### 期望执行方式
|
||
|
||
- 优先判断这是树表，不生成分页 `PageResult` 页面。
|
||
- API 列表返回 `AxiosPromise<Tree2VO[]>`。
|
||
- `Query` 不继承 `PageQuery`。
|
||
- 页面使用 `handleTree`、`row-key`、`tree-props`、`useTreeTableExpand`、`el-tree-select`。
|
||
- 新增子节点时从当前行带入 `parentId`。
|
||
|
||
## 案例 3：修改已有复杂列表页
|
||
|
||
### 用户提问示例
|
||
|
||
```text
|
||
使用 $frontend-crud-coding 修改 system/user 页面：
|
||
1. 新增一个创建时间快捷筛选
|
||
2. 导出按钮保留在更多菜单中
|
||
3. 保持现有树筛选、导入、列显隐、详情抽屉和角色分配不变
|
||
```
|
||
|
||
### 期望执行方式
|
||
|
||
- 判断这是“已有复杂页面增强”，不是重新生成 CRUD。
|
||
- 优先阅读 `src/views/system/user/index.vue`。
|
||
- 保留 `TreePanel`、导入弹窗、`right-toolbar` 列显隐、`UserViewDrawer`、角色分配路由、权限控制。
|
||
- 只增量修改搜索和查询参数处理。
|
||
|
||
## 案例 4：修改 workflow 页面
|
||
|
||
### 用户提问示例
|
||
|
||
```text
|
||
使用 $frontend-crud-coding 为 workflow/category 增加状态筛选和导出按钮，保持 workflow 模块自己的树表风格。
|
||
```
|
||
|
||
### 期望执行方式
|
||
|
||
- 优先看 `src/views/workflow/category/index.vue` 和 `src/api/workflow/category/*`。
|
||
- 判断是否需要后端新增导出接口；前端导出路径保持 `workflow/category/export`。
|
||
- 不迁移 system/user 的用户专属逻辑。
|
||
- 保留树表、`useTreeTableExpand`、`handleTree` 和分类弹窗逻辑。
|
||
|
||
## 案例 5：只补 API 和 types
|
||
|
||
### 用户提问示例
|
||
|
||
```text
|
||
使用 $frontend-crud-coding 为 monitor/cache 补全前端 API 和 types，页面先不改。
|
||
```
|
||
|
||
### 期望执行方式
|
||
|
||
- 只维护 `src/api/monitor/cache/index.ts` 和 `src/api/monitor/cache/types.ts`。
|
||
- 仍然检查同目录 monitor API 的 `export function` / `export const` 风格。
|
||
- 返回类型使用 `AxiosPromise` from `@/utils/api-types`。
|
||
- 不创建页面，不改路由。
|
||
|
||
## 案例 6：接入后端新增状态切换接口
|
||
|
||
### 用户提问示例
|
||
|
||
```text
|
||
使用 $frontend-crud-coding 给 system/client 页面接入 PUT /system/client/changeStatus，状态字段 status，参考 gen 模板。
|
||
```
|
||
|
||
### 期望执行方式
|
||
|
||
- API 增加 `changeClientStatus(id, status)`。
|
||
- types 确认 `status` 类型是 string、number 还是 boolean。
|
||
- 表格列用 `el-switch`，active/inactive 值跟后端字段类型一致。
|
||
- 切换失败时回滚原状态。
|
||
- 权限使用 `system:client:edit` 或后端实际权限。
|
||
|
||
## 推荐的高质量任务描述
|
||
|
||
```text
|
||
使用 $frontend-crud-coding 在当前前端项目中新增 `/system/notice` 列表页增强：
|
||
1. 保留现有页面
|
||
2. 新增状态筛选和导出
|
||
3. API 路径沿用后端接口
|
||
4. 参考 system/config 的工具栏与导出交互
|
||
5. 参考 gen 模板补齐缺失 types
|
||
```
|
||
|
||
## 不推荐的任务描述
|
||
|
||
```text
|
||
帮我写个后台页面
|
||
```
|
||
|
||
更好的写法至少补充：
|
||
|
||
- 模块名
|
||
- 业务名
|
||
- 后端接口前缀
|
||
- 是新增还是修改
|
||
- 是否需要分页、导出、树表、字典、权限
|
||
- 想参考哪个现有页面
|