本页按模块分组列出平台主要后端接口端点,便于开发联调时快速定位。所有接口均以 /api 为前缀,统一返回 com.lowcode.common.Result<T>(code / msg / data)。
路径约定
- 后端控制器统一以
@RequestMapping("/api/模块名") 为前缀。 - 前端 axios
baseURL = '/api',因此前端请求路径不要再带 /api,否则会双重前缀 404,详见 。 - 除登录 / 验证码 / SSO / 开放平台 / 移动端外,其余接口需在 Header 携带
Authorization: Bearer <JWT>。
| 方法 | 路径 | 说明 |
|---|
| POST | /login | 账号密码登录,签发 JWT |
| GET | /userInfo | 获取当前登录用户信息 |
| POST | /logout | 登出 |
| GET | /captcha | 获取图形验证码 |
| GET | /permissions | 获取当前用户权限标识 |
| GET | /roles | 获取当前用户角色 |
| POST | /sso/login | SSO 登录 |
| 方法 | 路径 | 说明 |
|---|
| GET | /providers | 获取已启用的 SSO 提供商列表 |
| GET | /authorize/{providerCode} | 跳转到提供商授权页 |
| GET | /callback/{providerCode} | 授权回调 |
| POST | /token | 用授权码换取平台 Token |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 用户分页列表 |
| GET | /{id} | 用户详情 |
| GET | /{id}/postIds | 用户关联岗位 |
| GET | /{id}/appIds | 用户关联应用 |
| GET | /me/appIds | 当前用户应用列表 |
| POST | | 新增用户 |
| PUT | | 修改用户 |
| DELETE | /{id} | 删除用户 |
| PUT | /resetPwd | 重置密码 |
| PUT | /changeStatus | 修改用户状态 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 角色分页列表 |
| GET | /all | 全部角色(下拉用) |
| GET | /{id} | 角色详情 |
| POST | | 新增角色 |
| PUT | | 修改角色 |
| DELETE | /{id} | 删除角色 |
| PUT | /changeStatus | 修改角色状态 |
| GET | /{roleId}/permissions | 角色权限列表 |
| PUT | /{roleId}/permissions | 保存角色权限 |
| 方法 | 路径 | 说明 |
|---|
| GET | /tree | 菜单树 |
| GET | /list | 菜单列表 |
| GET | /{id} | 菜单详情 |
| POST | | 新增菜单 |
| PUT | | 修改菜单 |
| DELETE | /{id} | 删除菜单 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 部门列表 |
| GET | /tree | 部门树 |
| GET | /get | 部门详情 |
| POST | /create | 新增部门 |
| PUT | /update | 修改部门 |
| DELETE | /delete | 删除部门 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 岗位列表 |
| GET | /get | 岗位详情 |
| POST | /create | 新增岗位 |
| PUT | /update | 修改岗位 |
| DELETE | /delete | 删除岗位 |
| GET | /options | 岗位下拉选项 |
| 方法 | 路径 | 说明 |
|---|
| GET | /type/list | 字典类型分页 |
| GET | /type/all | 全部字典类型 |
| GET | /type/{id} | 字典类型详情 |
| POST | /type | 新增字典类型 |
| PUT | /type | 修改字典类型 |
| DELETE | /type/{id} | 删除字典类型 |
| GET | /data/byType/{dictType} | 按类型取字典数据 |
| GET | /data/list | 字典数据分页 |
| GET | /data/{id} | 字典数据详情 |
| POST | /data | 新增字典数据 |
| PUT | /data | 修改字典数据 |
| DELETE | /data/{id} | 删除字典数据 |
| 方法 | 路径 | 说明 |
|---|
| GET | /options | 租户下拉选项 |
| GET | /list | 租户分页列表 |
| GET | /{id} | 租户详情 |
| POST | | 新增租户 |
| PUT | | 修改租户 |
| GET | /{id}/menus | 租户菜单范围 |
| PUT | /{id}/menus | 保存租户菜单范围 |
| DELETE | /{id} | 删除租户 |
| 方法 | 路径 | 说明 |
|---|
| GET | /audit | 审计配置 |
| PUT | /audit | 保存审计配置 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 审计日志列表 |
| GET | /login | 登录日志 |
| GET | /logout | 登出日志 |
| GET | /operation | 操作日志 |
| GET | /history/{tableName}/{recordId} | 数据变更历史 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | AI 模型配置列表 |
| GET | /{id} | 配置详情 |
| POST | | 新增配置 |
| PUT | | 修改配置 |
| DELETE | /{id} | 删除配置 |
| PUT | /changeStatus | 启用/禁用 |
| PUT | /setDefault/{id} | 设为默认模型 |
| POST | /test | 测试模型连通性 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | SSO 提供商分页 |
| GET | /all | 全部提供商 |
| GET | /{id} | 详情 |
| POST | | 新增 |
| PUT | | 修改 |
| DELETE | /{id} | 删除 |
| PUT | /changeStatus | 启用/禁用 |
| 方法 | 路径 | 说明 |
|---|
| GET | /overview | 系统概览 |
| GET | /mysql | MySQL 状态 |
| GET | /redis | Redis 状态 |
| 方法 | 路径 | 说明 |
|---|
| GET | /table/list | 表列表 |
| GET | /table/list/{appId} | 按应用取表列表 |
| GET | /table/{id} | 表详情 |
| GET | /table/columns/{tableId} | 表字段列表 |
| POST | /table/columns/save | 保存字段配置 |
| POST | /table/execute/{tableId} | 执行表操作 |
| POST | /table/generateSql | 生成建表 SQL |
| POST | /table/create | 创建表 |
| PUT | /table/update | 修改表结构 |
| DELETE | /table/{id} | 删除表 |
| POST | /table/{id}/data/list | 动态查询表数据 |
| GET | /table/{id}/data/{dataId} | 动态查询单条数据 |
| POST | /table/{id}/data | 动态新增数据 |
| PUT | /table/{id}/data/{dataId} | 动态修改数据 |
| DELETE | /table/{id}/data/{dataId} | 动态删除数据 |
| GET | /table/{id}/open-api | 查询开放接口配置 |
| PUT | /table/{id}/open-api | 保存开放接口配置 |
| POST | /table/{id}/open-api/token | 生成开放接口 Token |
| GET | /table/{tableId}/column/{columnName}/options | 字段下拉选项 |
| GET | /table/{id}/data/export | 导出表数据 |
| POST | /table/{id}/data/import | 导入表数据 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 数据源列表 |
| GET | /{id} | 数据源详情 |
| POST | | 新增数据源 |
| PUT | | 修改数据源 |
| DELETE | /{id} | 删除数据源 |
| POST | /test/{id} | 测试数据源连通性 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 表关系列表 |
| GET | /{id} | 表关系详情 |
| POST | | 新增表关系 |
| PUT | | 修改表关系 |
| DELETE | /{id} | 删除表关系 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 表单列表 |
| GET | /get/{id} | 表单详情 |
| GET | /getByCode/{code} | 按编码取表单 |
| POST | /save | 保存表单 |
| DELETE | /delete/{id} | 删除表单 |
| POST | /publish/{id} | 发布表单 |
| POST | /unpublish/{id} | 取消发布 |
| 方法 | 路径 | 说明 |
|---|
| POST | /save/{formId} | 保存版本 |
| GET | /history/{formId} | 版本历史 |
| GET | /{formId}/{version} | 取指定版本 |
| POST | /rollback/{formId}/{version} | 回滚到版本 |
| GET | /current/{formId} | 当前版本 |
| GET | /compare/{formId} | 版本对比 |
| 方法 | 路径 | 说明 |
|---|
| GET | /role-permission-matrix | 角色权限矩阵 |
| PUT | /role/{roleId}/menus | 保存角色菜单权限 |
| GET | /field-permissions/{roleId} | 字段权限 |
| PUT | /field-permissions/{roleId} | 保存字段权限 |
| GET | /data-permission-rules/{roleId} | 数据权限规则 |
| PUT | /data-permission-rules/{roleId} | 保存数据权限规则 |
| GET | /button-permissions/{roleId} | 按钮权限 |
| PUT | /button-permissions/{roleId} | 保存按钮权限 |
| 方法 | 路径 | 说明 |
|---|
| GET | /builder/list | 列表配置列表 |
| GET | /builder/{id} | 列表配置详情 |
| POST | /builder/save | 保存列表配置 |
| PUT | /builder/{id} | 修改列表配置 |
| DELETE | /builder/{id} | 删除列表配置 |
| POST | /builder/build/{id} | 构建列表 |
| 方法 | 路径 | 说明 |
|---|
| POST | /save/{listId} | 保存版本 |
| GET | /history/{listId} | 版本历史 |
| GET | /{listId}/{version} | 取指定版本 |
| POST | /rollback/{listId}/{version} | 回滚到版本 |
| GET | /current/{listId} | 当前版本 |
| GET | /compare/{listId} | 版本对比 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 页面列表 |
| GET | /{id} | 页面详情 |
| POST | | 新增页面 |
| PUT | | 修改页面 |
| DELETE | /{id} | 删除页面 |
| POST | /save | 保存页面配置 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 图表列表 |
| GET | /{id} | 图表详情 |
| POST | /save | 保存图表 |
| PUT | /{id} | 修改图表 |
| DELETE | /{id} | 删除图表 |
| POST | /data/{id} | 查询图表数据 |
| 方法 | 路径 | 说明 |
|---|
| GET | /dashboard | 仪表盘统计数据 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 报表列表 |
| GET | /{id} | 报表详情 |
| POST | | 新增报表 |
| PUT | | 修改报表 |
| DELETE | /{id} | 删除报表 |
| POST | /data/{id} | 查询报表数据 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 打印模板列表 |
| GET | /{id} | 模板详情 |
| POST | /save | 保存模板 |
| PUT | /{id} | 修改模板 |
| DELETE | /{id} | 删除模板 |
| GET | /preview/{id} | 预览模板 |
| GET | /export/{id} | 导出打印文件 |
| GET | /fields/{formId} | 表单可用字段 |
| 方法 | 路径 | 说明 |
|---|
| GET | /design/list | 流程设计列表 |
| GET | /design/{id} | 流程设计详情 |
| POST | /design/save | 保存流程设计 |
| PUT | /design/{id} | 修改流程设计 |
| DELETE | /design/{id} | 删除流程设计 |
| POST | /design/deploy/{id} | 部署流程 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 流程定义列表 |
| GET | /page | 流程定义分页 |
| GET | /{id} | 流程定义详情 |
| POST | | 新增流程定义 |
| PUT | | 修改流程定义 |
| DELETE | /{id} | 删除流程定义 |
| POST | /publish/{id} | 发布流程 |
| POST | /disable/{id} | 禁用流程 |
| POST | /create | 创建流程 |
| GET | /design/{id} | 设计器数据 |
| GET | /preview/{id} | 预览流程 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 模型列表 |
| GET | /get | 模型详情 |
| POST | /create | 新增模型 |
| PUT | /update | 修改模型 |
| DELETE | /delete | 删除模型 |
| POST | /deploy | 部署模型 |
| GET | /simple/get | Simple 设计器数据 |
| POST | /simple/update | 保存 Simple 设计器数据 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 流程表单列表 |
| GET | /get | 表单详情 |
| POST | /create | 新增表单 |
| PUT | /update | 修改表单 |
| DELETE | /delete | 删除表单 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 流程实例列表 |
| GET | /page | 流程实例分页 |
| GET | /{id} | 实例详情 |
| POST | /start | 启动流程 |
| POST | /startByKey | 按 key 启动流程 |
| GET | /available | 可发起的流程列表 |
| POST | /cancel/{id} | 撤销流程 |
| GET | /{id}/tasks | 实例任务列表 |
| GET | /view/{id} | 实例详情视图 |
| GET | /flow/{id} | 流程流转图 |
| POST | /cc/{id} | 抄送 |
| GET | /cc/{id} | 抄送列表 |
| POST | /recall/{id} | 撤回 |
| 方法 | 路径 | 说明 |
|---|
| GET | /todo | 待办任务 |
| GET | /done | 已办任务 |
| GET | /myStarted | 我发起的 |
| GET | /{id} | 任务详情 |
| GET | /detail/{id} | 任务详情视图 |
| GET | /transferHistory/{id} | 转办历史 |
| POST | /approve/{id} | 审批通过 |
| POST | /reject/{id} | 审批驳回 |
| POST | /delegate/{id} | 委托 |
| POST | /transfer/{id} | 转办 |
| POST | /urge/{id} | 催办 |
| POST | /revoke/{id} | 撤回任务 |
| POST | /transferTask/{id} | 转办任务 |
| POST | /delegateTask/{id} | 委托任务 |
| POST | /follow/{id} | 关注 |
| DELETE | /follow/{id} | 取消关注 |
| 方法 | 路径 | 说明 |
|---|
| GET | /task/{taskId} | 任务的会签列表 |
| GET | /instance/{instanceId} | 实例的会签列表 |
| GET | /{signId} | 会签详情 |
| POST | /approve/{signId} | 会签通过 |
| POST | /reject/{signId} | 会签驳回 |
| POST | /addBefore/{signId} | 前加签 |
| POST | /addAfter/{signId} | 后加签 |
| POST | /create | 创建会签任务 |
| 方法 | 路径 | 说明 |
|---|
| GET | /instance/{instanceId} | 实例审批记录 |
| GET | /task/{taskId} | 任务审批记录 |
| POST | /comment | 添加评论 |
| POST | /copy | 抄送 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 流程分类列表 |
| GET | /get | 分类详情 |
| POST | /create | 新增分类 |
| PUT | /update | 修改分类 |
| DELETE | /delete | 删除分类 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 用户组列表 |
| GET | /get | 用户组详情 |
| POST | /create | 新增用户组 |
| PUT | /update | 修改用户组 |
| DELETE | /delete | 删除用户组 |
| 方法 | 路径 | 说明 |
|---|
| POST | /submit/{formId} | 提交审批(新增数据) |
| POST | /submit/{formId}/{dataId} | 提交审批(已有数据) |
| GET | /status/{formId}/{dataId} | 查询审批状态 |
| POST | /status/batch/{formId} | 批量查询审批状态 |
| 方法 | 路径 | 说明 |
|---|
| GET | /page/{pageId} | 运行时渲染页面 |
| GET | /menu/{appId} | 应用运行时菜单 |
| POST | /data | 运行时查询数据 |
| POST | /data/submit | 运行时提交数据 |
| POST | /statistic | 运行时统计 |
| 方法 | 路径 | 说明 |
|---|
| GET | /{publicCode}/list | 公开内容列表 |
| GET | /{publicCode}/{id} | 公开内容详情 |
| POST | /{publicCode}/leads | 提交线索 |
| GET | /donations/summary | 捐赠汇总 |
| 方法 | 路径 | 说明 |
|---|
| POST | /records | 新增记录 |
| PUT | /records/{id} | 修改记录 |
| POST | /query | 查询记录 |
每个模块均为标准 CRUD(GET /list 分页列表、GET /page 分页、GET /{id} 详情、POST 新增、PUT 修改、DELETE /{id} 删除),部分含业务动作。
GET /list GET /page GET /{id} POST PUT /{id} DELETE /{id} -- 采购计划 CRUD
GET /list GET /page GET /{id} POST PUT DELETE /{id} POST /submit/{id} -- 采购订单 CRUD + 提交审批
GET /list GET /page GET /{id} POST PUT DELETE /{id} DELETE /batch -- 供应商 CRUD + 批量删除
GET /list GET /page GET /{id} POST PUT DELETE /{id} -- 商品 CRUD
GET /list GET /page GET /{id} POST PUT DELETE /{id} -- 客户 CRUD
GET /list GET /page GET /{id} POST PUT DELETE /{id} POST /deliver/{id} -- 销售订单 CRUD + 发货
GET /list GET /page GET /{id} POST PUT DELETE /{id} POST /submit/{id} -- 合同 CRUD + 提交审批
GET /list GET /page GET /{id} GET /warning POST PUT DELETE /{id} -- 库存 CRUD + 库存预警
GET /list GET /page GET /{id} POST PUT DELETE /{id} -- 仓库 CRUD
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 员工列表 |
| GET | /{id} | 员工详情 |
| POST | | 新增员工 |
| PUT | | 修改员工 |
| DELETE | /{id} | 删除员工 |
| PUT | /regular | 员工转正 |
| PUT | /resign | 员工离职 |
| GET | /export | 导出员工 |
GET /list GET /page GET /{id} POST PUT /{id} DELETE /{id} GET /view/{id} -- 招聘需求 CRUD
GET /list GET /page GET /{id} POST PUT /{id} DELETE /{id} -- 面试记录 CRUD
| 方法 | 路径 | 说明 |
|---|
| POST | /preview/{tableId} | 预览生成代码 |
| POST | /generate/{tableId} | 生成代码 |
| POST | /download/{tableId} | 下载生成代码 |
| GET | /table/list | 可生成代码的表列表 |
| 方法 | 路径 | 说明 |
|---|
| GET | /list | 应用列表 |
| GET | /{id} | 应用详情 |
| POST | /create | 新增应用 |
| PUT | /{id} | 修改应用 |
| DELETE | /{id} | 删除应用 |
| POST | /copy/{id} | 复制应用 |
| POST | /publish/{id} | 发布应用 |
| POST | /unpublish/{id} | 取消发布 |
| GET | /export/{id} | 导出应用 |
| GET | /list/{appId} | 应用下资源列表 |
| GET | /{id}/full | 应用完整配置 |
| GET | /{id}/workbench | 应用工作台 |
| 方法 | 路径 | 说明 |
|---|
| POST | /{appId}/export-springboot | 导出 Spring Boot 单模块工程 |
| POST | /{appId}/export-springboot-multi | 导出 Spring Boot 多模块 Maven 工程 |
| POST | /{appId}/export-mobile-app | 导出移动端 App |
| POST | /{appId}/export-mobile-mp | 导出移动端小程序 |
| GET | /{appId}/export-defaults | 导出默认配置 |
GET /tree GET /list GET /{id} POST PUT DELETE /{id} -- 应用菜单 CRUD
GET /list GET /{id} POST /create PUT /{id} DELETE /{id} POST /use/{id} -- 行业模板 CRUD + 应用模板
| 方法 | 路径 | 说明 |
|---|
| POST | /chat | AI 对话 |
| POST | /form-designer-chat | 表单设计器对话(SSE 流式) |
| POST | /generate/sql | 生成建表 SQL |
| POST | /generate/form-config | 生成表单配置 |
| POST | /generate/table-fields | 生成表字段 |
| POST | /executeSql | 执行 SQL |
| POST | /applyForm | 应用表单 |
| 方法 | 路径 | 说明 |
|---|
| POST | | 单文件上传 |
| POST | /batch | 批量上传 |
| 方法 | 路径 | 说明 |
|---|
| GET | /template/{tableId} | 下载导入模板 |
| POST | /preview/{tableId} | 导入预览 |
| POST | /execute/{tableId} | 执行导入 |
| POST | /batch/{tableId} | 批量导入 |
| 方法 | 路径 | 说明 |
|---|
| GET | /excel/{tableId} | 导出 Excel |
| POST | /import/excel/{tableId}/preview | Excel 导入预览 |
| POST | /import/excel/{tableId} | Excel 导入 |
| 方法 | 路径 | 说明 |
|---|
| POST | /announcement/publish | 发布公告 |
| GET | /list | 通知列表 |
| GET | /unread-count | 未读数量 |
| PUT | /read/{id} | 标记已读 |
| PUT | /read-all | 全部已读 |
| DELETE | /{id} | 删除通知 |
| 方法 | 路径 | 说明 |
|---|
| POST | /site-layout/switch | 切换站点布局 |
| GET | /site-layout/current | 当前站点布局 |
| 方法 | 路径 | 说明 |
|---|
| GET | /table/{tableName} | 取表元数据 |
| GET | /table/{tableName}/columns | 取表字段 |
| GET | /{tableName}/list | 查询列表 |
| GET | /{tableName}/get/{id} | 查询详情 |
| POST | /{tableName}/create | 新增 |
| PUT | /{tableName}/update/{id} | 修改 |
| DELETE | /{tableName}/delete/{id} | 删除单条 |
| DELETE | /{tableName}/delete | 批量删除 |
说明
本表为平台主要端点速查,部分内部辅助接口未全部列出。完整实现见 backend/src/main/java/com/lowcode/controller/ 下各控制器源码。数据库表清单见 。