datai/docs/api-docs/template.md
Kris b7163d555b feat: 实现动态数据源延迟加载功能 (2026-01-21-001)
## 功能概述
- 实现动态数据源的延迟加载机制,支持应用启动时只加载主库,从库按需动态加载和切换
- 从库配置存储在主库中,支持运行时灵活切换从库库名
- 使用现有的 @DataSource 注解进行数据源切换,业务代码无需修改

## 新增功能
- 动态数据源管理接口 IDynamicDataSourceManager
- 动态数据源服务接口 IDynamicDataSourceService
- 动态数据源服务实现 DynamicDataSourceServiceImpl
- 数据源管理控制器 DatasourceController
- 数据源配置表 sys_datasource_config

## 新增文档
- 需求文档: docs/requirements/2026-01-21-001-动态数据源延迟加载.md
- 设计文档: docs/design/2026-01-21-001-动态数据源延迟加载设计.md
- 决策记录: docs/decisions/2026-01-21-001-ADR-动态数据源延迟加载.md
- SQL 脚本: docs/sql/2026-01-21-001-sys_datasource_config.sql
- 提示词: docs/prompts/2026-01-21-001-动态数据源延迟加载代码生成提示词.md
- 会话记录: docs/sessions/2026-01-21-001-session.md
- 变更日志: docs/changelog/2026-01-21-001-changelog.md
- 复盘文档: docs/retros/2026-01-21-001-retro.md
- API 文档: docs/api-docs/2026-01-21-001-api.md
- 根目录变更日志: CHANGELOG.md

## 修改功能
- 扩展 DataSourceManager 类,添加动态数据源管理方法
- 扩展 SysDatasourceConfigMapper 接口,添加 selectSysDatasourceConfigByDsName 方法
- 更新项目索引和 Authentication.canvas

## 修复问题
- 修复循环依赖问题:创建 IDynamicDataSourceManager 接口解决 datai-system 和 datai-framework 互相依赖
- 修复导入错误:删除 DynamicDataSourceServiceImpl 中未使用的导入
- 修复异常处理:将 setFilters() 调用移到 try-catch 块内

## API 接口
- POST /system/datasource/loadSlave - 加载从库数据源
- POST /system/datasource/switchSlave/{dbName} - 切换从库库名
- GET /system/datasource/getSlaveConfig - 获取从库配置
- POST /system/datasource/switch/{dsName} - 切换数据源
- DELETE /system/datasource/{dsName} - 移除数据源
2026-01-21 18:24:24 +08:00

1.6 KiB
Raw Permalink Blame History

API 文档模板

元数据

  • 需求编号:
  • 创建时间YYYY-MM-DD
  • 创建人:
  • 版本1.0.0

API 概述

[API 概述]

基础信息

  • API 名称:
  • API 版本:
  • 描述:
  • 认证方式:

端点列表

接口 1[接口名称]

  • 请求方式GET/POST/PUT/DELETE
  • 请求路径/api/xxx
  • 功能描述
  • 请求参数
    参数名 类型 必填 描述 示例值
    param1 String 参数1描述 value1
    param2 Integer 参数2描述 100
  • 请求体
    {
      "field1": "value1",
      "field2": 123
    }
    
  • 响应参数
    参数名 类型 描述
    code Integer 响应码
    message String 响应信息
    data Object 响应数据
  • 成功响应示例
    {
      "code": 200,
      "message": "success",
      "data": {
        "result": "ok"
      }
    }
    
  • 错误响应示例
    {
      "code": 400,
      "message": "Bad Request",
      "data": null
    }
    
  • 状态码
    状态码 描述
    200 成功
    400 请求参数错误
    401 未认证
    403 无权限
    500 服务器内部错误
  • 注意事项
    • 注意事项1
    • 注意事项2

变更历史

版本 时间 变更内容 变更人
1.0.0 YYYY-MM-DD 初始版本

相关文档