4.0 KiB
4.0 KiB
接口迁移确认文档 - 待确认接口
📋 背景
前端已完成以下接口的迁移，从基于 Low_Code_TableId 的方式迁移到基于 tableName + dataBase 的方式：
✅ 已迁移接口：
POST /api/v1/admin/LowCodeTableInfo/FindListByTable- 查询列列表POST /api/v1/admin/LowCodeTableInfo/ChangeByTable- 保存列配置
❓ 待确认接口
以下接口目前仍在使用 id 或 tableId 参数，需要确认是否有对应的新版本接口（基于 tableName + dataBase）：
1. 同步字段接口
当前接口：
- 路径：
POST /api/v1/admin/LowCodeTableInfo/synchronization/{tableId} - 方法：
POST - 参数：
tableId(路径参数，Guid格式) - 用途：同步指定表的字段信息（从数据库同步到内存缓存）
使用位置：
- 文件：
src/views/development_tool/low_code/components/Columns.vue - 代码：
LowCodeTableInfoService.synchronization(props.rowData.id)
问题：
- 是否提供新版本接口，使用
tableName + dataBase替代tableId？ - 如果有，新接口路径和参数格式是什么？
2. 获取表配置表单接口
当前接口：
- 路径：
GET /api/v1/admin/LowCodeTable/findForm/{id} - 方法：
GET - 参数：
id(路径参数，Guid格式，可选) - 用途：获取表的配置表单信息（代码生成路径配置等）
使用位置：
- 文件：
src/views/development_tool/low_code/components/CodeLoadToProject.vue - 代码：
LowCodeTableService.findForm(props.rowData.id)
问题：
- 是否提供新版本接口，使用
tableName + dataBase替代id？ - 如果有，新接口路径和参数格式是什么？
3. 保存表配置表单接口
当前接口：
- 路径：
POST /api/v1/admin/LowCodeTable/{id ? "update" : "create"} - 方法：
POST - 参数：
id(用于判断是更新还是创建),formData(表单数据) - 用途：保存表的配置表单信息（代码生成路径配置等）
使用位置：
- 文件：
src/views/development_tool/low_code/components/CodeLoadToProject.vue - 代码：
LowCodeTableService.saveForm(state.vm.id, state.vm.form)
问题：
- 是否提供新版本接口，使用
tableName + dataBase替代id？ - 如果有，新接口路径和参数格式是什么？
- 更新和创建的逻辑如何区分？
4. 表级别数据变更接口
当前接口：
- 路径：
POST /api/v1/admin/LowCodeTable/change - 方法：
POST - 参数：
list(表数据数组) - 用途：保存表级别的数据变更（如显示名称、实体名称、备注等）
使用位置：
- 文件：
src/views/development_tool/low_code/Index.vue - 代码：
LowCodeTableService.change(state.data)
问题：
- 这个接口是否也需要迁移到基于
tableName + dataBase的方式？ - 如果有新版本，新接口路径和参数格式是什么？
📝 迁移原则
根据已迁移接口的经验，新接口应该遵循以下原则：
- 使用业务标识：使用
tableName + dataBase替代id或tableId - 直接匹配：直接从内存缓存查询，不依赖数据库表记录
- 更可靠：避免因数据库记录缺失而导致的失败
🔍 需要的信息
对于每个待确认的接口，请提供：
-
是否有新版本接口？
- ✅ 有 → 请提供接口文档（路径、方法、参数、响应）
- ❌ 没有 → 是否计划提供？预计时间？
-
如果有新版本，请提供：
- 接口路径
- 请求方法（GET/POST/PUT/DELETE）
- 请求参数结构（TypeScript 类型定义）
- 响应数据结构
- 请求示例
- 响应示例
-
如果没有新版本：
- 当前接口是否仍然可用？
- 是否有迁移计划？
- 预计何时提供新版本？
📞 联系方式
如有疑问，请联系前端开发团队。
📅 文档日期
创建日期：2024年（当前日期）