kris/datai-vue
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
develop
datai-vue/docs/api-docs/index.md
Kris a66ecad0f9 feat: 修复初始化从库接口参数并完善环境管理功能 
- 更新 environment.js 中 initSlaveDatasource 函数参数从 environmentCode 改为 environmentId
- 更新 SourceEnvironmentTab.vue 中的初始化从库功能以使用 environmentId
- 在 TargetEnvironmentTab.vue 中添加完整的初始化从库功能
- 初始化项目单一真源（SSOT）文档结构，包括：
  - 创建主 index.md 作为项目单一真源
  - 创建 Authentication.canvas 可视化文件
  - 创建所有必需的文档目录和 README.md 文件
  - 建立完整的双向索引关系
2026-01-26 17:23:15 +08:00

252 lines
19 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# API 文档索引
## 概述
本目录包含 Salesforce 集成系统的所有 API 文档，按模块分类组织。
## 模块列表
- [2026-01-25-002-07-api.md](2026-01-25-002-07-api.md) - 数字格式化功能 API
- [2026-01-21-002-02-api-后端国际化.md](system/2026-01-21-002-02-api-后端国际化.md) - 后端国际化接口 API
- [2026-01-21-002-02-01-api-刷新国际化资源.md](system/2026-01-21-002-02-01-api-刷新国际化资源.md) - 刷新国际化资源接口
- [2026-01-21-002-02-02-api-获取当前语言偏好.md](system/2026-01-21-002-02-02-api-获取当前语言偏好.md) - 获取当前语言偏好接口
- [2026-01-21-002-02-03-api-更新用户语言偏好.md](system/2026-01-21-002-02-03-api-更新用户语言偏好.md) - 更新用户语言偏好接口
- [2026-01-21-002-03-api-数据库国际化.md](system/2026-01-21-002-03-api-数据库国际化.md) - 数据库国际化接口 API
- [2026-01-21-002-03-01-api-查询字典数据列表.md](system/2026-01-21-002-03-01-api-查询字典数据列表.md) - 查询字典数据列表接口
- [2026-01-21-002-03-02-api-导出字典数据列表.md](system/2026-01-21-002-03-02-api-导出字典数据列表.md) - 导出字典数据列表接口
- [2026-01-21-002-03-03-api-获取字典数据详细信息.md](system/2026-01-21-002-03-03-api-获取字典数据详细信息.md) - 获取字典数据详细信息接口
- [2026-01-21-002-03-04-api-根据字典类型查询字典数据信息.md](system/2026-01-21-002-03-04-api-根据字典类型查询字典数据信息.md) - 根据字典类型查询字典数据信息接口
- [2026-01-21-002-03-05-api-新增字典数据.md](system/2026-01-21-002-03-05-api-新增字典数据.md) - 新增字典数据接口
- [2026-01-21-002-03-06-api-修改字典数据.md](system/2026-01-21-002-03-06-api-修改字典数据.md) - 修改字典数据接口
- [2026-01-21-002-03-07-api-删除字典数据.md](system/2026-01-21-002-03-07-api-删除字典数据.md) - 删除字典数据接口
- [2026-01-21-002-03-08-api-查询字典类型列表.md](system/2026-01-21-002-03-08-api-查询字典类型列表.md) - 查询字典类型列表接口
- [2026-01-21-002-03-09-api-导出字典类型列表.md](system/2026-01-21-002-03-09-api-导出字典类型列表.md) - 导出字典类型列表接口
- [2026-01-21-002-03-10-api-获取字典类型详细信息.md](system/2026-01-21-002-03-10-api-获取字典类型详细信息.md) - 获取字典类型详细信息接口
- [2026-01-21-002-03-11-api-新增字典类型.md](system/2026-01-21-002-03-11-api-新增字典类型.md) - 新增字典类型接口
- [2026-01-21-002-03-12-api-修改字典类型.md](system/2026-01-21-002-03-12-api-修改字典类型.md) - 修改字典类型接口
- [2026-01-21-002-03-13-api-删除字典类型.md](system/2026-01-21-002-03-13-api-删除字典类型.md) - 删除字典类型接口
- [2026-01-21-002-03-14-api-刷新字典缓存.md](system/2026-01-21-002-03-14-api-刷新字典缓存.md) - 刷新字典缓存接口
- [2026-01-21-002-03-15-api-获取字典选择框列表.md](system/2026-01-21-002-03-15-api-获取字典选择框列表.md) - 获取字典选择框列表接口
- [2026-01-21-002-03-16-api-获取参数配置列表.md](system/2026-01-21-002-03-16-api-获取参数配置列表.md) - 获取参数配置列表接口
- [2026-01-21-002-03-17-api-导出参数配置列表.md](system/2026-01-21-002-03-17-api-导出参数配置列表.md) - 导出参数配置列表接口
- [2026-01-21-002-03-18-api-获取参数配置详细信息.md](system/2026-01-21-002-03-18-api-获取参数配置详细信息.md) - 获取参数配置详细信息接口
- [2026-01-21-002-03-19-api-根据参数键名查询参数值.md](system/2026-01-21-002-03-19-api-根据参数键名查询参数值.md) - 根据参数键名查询参数值接口
- [2026-01-21-002-03-20-api-新增参数配置.md](system/2026-01-21-002-03-20-api-新增参数配置.md) - 新增参数配置接口
- [2026-01-21-002-03-21-api-修改参数配置.md](system/2026-01-21-002-03-21-api-修改参数配置.md) - 修改参数配置接口
- [2026-01-21-002-03-22-api-删除参数配置.md](system/2026-01-21-002-03-22-api-删除参数配置.md) - 删除参数配置接口
- [2026-01-21-002-03-23-api-刷新参数缓存.md](system/2026-01-21-002-03-23-api-刷新参数缓存.md) - 刷新参数缓存接口
- [2026-01-21-002-03-24-api-获取菜单列表.md](system/2026-01-21-002-03-24-api-获取菜单列表.md) - 获取菜单列表接口
- [2026-01-21-002-03-25-api-获取菜单详细信息.md](system/2026-01-21-002-03-25-api-获取菜单详细信息.md) - 获取菜单详细信息接口
- [2026-01-21-002-03-26-api-获取菜单下拉树列表.md](system/2026-01-21-002-03-26-api-获取菜单下拉树列表.md) - 获取菜单下拉树列表接口
- [2026-01-21-002-03-27-api-加载对应角色菜单列表树.md](system/2026-01-21-002-03-27-api-加载对应角色菜单列表树.md) - 加载对应角色菜单列表树接口
- [2026-01-21-002-03-28-api-新增菜单.md](system/2026-01-21-002-03-28-api-新增菜单.md) - 新增菜单接口
- [2026-01-21-002-03-29-api-修改菜单.md](system/2026-01-21-002-03-29-api-修改菜单.md) - 修改菜单接口
- [2026-01-21-002-03-30-api-删除菜单.md](system/2026-01-21-002-03-30-api-删除菜单.md) - 删除菜单接口
- [2026-01-21-002-04-api-时区国际化.md](system/2026-01-21-002-04-api-时区国际化.md) - 时区国际化接口 API
- [2026-01-21-002-04-01-api-获取时区列表.md](system/2026-01-21-002-04-01-api-获取时区列表.md) - 获取时区列表接口
- [2026-01-21-002-04-02-api-获取当前用户时区.md](system/2026-01-21-002-04-02-api-获取当前用户时区.md) - 获取当前用户时区接口
- [2026-01-21-002-04-03-api-切换时区.md](system/2026-01-21-002-04-03-api-切换时区.md) - 切换时区接口
- [2026-01-21-002-04-04-api-获取默认时区.md](system/2026-01-21-002-04-04-api-获取默认时区.md) - 获取默认时区接口
- [2026-01-21-002-04-05-api-获取时区详细信息.md](system/2026-01-21-002-04-05-api-获取时区详细信息.md) - 获取时区详细信息接口
- [2026-01-21-002-04-06-api-刷新时区缓存.md](system/2026-01-21-002-04-06-api-刷新时区缓存.md) - 刷新时区缓存接口
- [2026-01-21-002-05-api-货币格式化.md](system/2026-01-21-002-05-api-货币格式化.md) - 货币格式化接口 API
- [2026-01-21-002-05-01-api-获取货币列表.md](system/2026-01-21-002-05-01-api-获取货币列表.md) - 获取货币列表接口
- [2026-01-21-002-05-02-api-获取当前用户货币偏好.md](system/2026-01-21-002-05-02-api-获取当前用户货币偏好.md) - 获取当前用户货币偏好接口
- [2026-01-21-002-05-03-api-切换货币.md](system/2026-01-21-002-05-03-api-切换货币.md) - 切换货币接口
- [2026-01-21-002-05-04-api-获取系统默认货币.md](system/2026-01-21-002-05-04-api-获取系统默认货币.md) - 获取系统默认货币接口
- [2026-01-21-002-05-05-api-获取汇率列表.md](system/2026-01-21-002-05-05-api-获取汇率列表.md) - 获取汇率列表接口
- [2026-01-21-002-05-06-api-格式化货币.md](system/2026-01-21-002-05-06-api-格式化货币.md) - 格式化货币接口
- [2026-01-21-002-05-07-api-刷新汇率缓存.md](system/2026-01-21-002-05-07-api-刷新汇率缓存.md) - 刷新汇率缓存接口
- [2026-01-21-002-06-api-日期格式化.md](system/2026-01-21-002-06-api-日期格式化.md) - 日期格式化接口 API
- [2026-01-21-002-06-01-api-获取日期格式列表.md](system/2026-01-21-002-06-01-api-获取日期格式列表.md) - 获取日期格式列表接口
- [2026-01-21-002-06-02-api-获取当前用户日期格式偏好.md](system/2026-01-21-002-06-02-api-获取当前用户日期格式偏好.md) - 获取当前用户日期格式偏好接口
- [2026-01-21-002-06-03-api-切换日期格式.md](system/2026-01-21-002-06-03-api-切换日期格式.md) - 切换日期格式接口
- [2026-01-21-002-06-04-api-获取系统默认日期格式.md](system/2026-01-21-002-06-04-api-获取系统默认日期格式.md) - 获取系统默认日期格式接口
- [2026-01-21-002-06-05-api-格式化日期.md](system/2026-01-21-002-06-05-api-格式化日期.md) - 格式化日期接口
- [2026-01-21-002-06-06-api-刷新日期格式缓存.md](system/2026-01-21-002-06-06-api-刷新日期格式缓存.md) - 刷新日期格式缓存接口
- [2026-01-21-002-07-api-数字格式化.md](system/2026-01-21-002-07-api-数字格式化.md) - 数字格式化接口 API
- [2026-01-21-002-07-01-api-获取数字格式列表.md](system/2026-01-21-002-07-01-api-获取数字格式列表.md) - 获取数字格式列表接口
- [2026-01-21-002-07-02-api-获取当前用户数字格式偏好.md](system/2026-01-21-002-07-02-api-获取当前用户数字格式偏好.md) - 获取当前用户数字格式偏好接口
- [2026-01-21-002-07-03-api-切换数字格式.md](system/2026-01-21-002-07-03-api-切换数字格式.md) - 切换数字格式接口
- [2026-01-21-002-07-04-api-获取系统默认数字格式.md](system/2026-01-21-002-07-04-api-获取系统默认数字格式.md) - 获取系统默认数字格式接口
- [2026-01-21-002-07-05-api-格式化数字.md](system/2026-01-21-002-07-05-api-格式化数字.md) - 格式化数字接口
- [2026-01-21-002-07-06-api-刷新数字格式缓存.md](system/2026-01-21-002-07-06-api-刷新数字格式缓存.md) - 刷新数字格式缓存接口
- [2026-01-26-002-08-api-语言管理.md](system/2026-01-26-002-08-api-语言管理.md) - 语言管理功能 API
- [2026-01-26-002-08-01-api-查询语言列表.md](system/2026-01-26-002-08-01-api-查询语言列表.md) - 查询语言列表接口
- [2026-01-26-002-08-02-api-获取语言详细信息.md](system/2026-01-26-002-08-02-api-获取语言详细信息.md) - 获取语言详细信息接口
- [2026-01-26-002-08-03-api-新增语言.md](system/2026-01-26-002-08-03-api-新增语言.md) - 新增语言接口
- [2026-01-26-002-08-04-api-修改语言.md](system/2026-01-26-002-08-04-api-修改语言.md) - 修改语言接口
- [2026-01-26-002-08-05-api-删除语言.md](system/2026-01-26-002-08-05-api-删除语言.md) - 删除语言接口
- [2026-01-26-002-08-06-api-设置默认语言.md](system/2026-01-26-002-08-06-api-设置默认语言.md) - 设置默认语言接口
- [2026-01-26-002-08-07-api-修改语言状态.md](system/2026-01-26-002-08-07-api-修改语言状态.md) - 修改语言状态接口
- [2026-01-26-002-08-08-api-获取默认语言.md](system/2026-01-26-002-08-08-api-获取默认语言.md) - 获取默认语言接口
- [2026-01-26-002-08-09-api-刷新语言缓存.md](system/2026-01-26-002-08-09-api-刷新语言缓存.md) - 刷新语言缓存接口
- [2026-01-26-002-09-api-国际化资源管理.md](system/2026-01-26-002-09-api-国际化资源管理.md) - 国际化资源管理功能 API
- [2026-01-26-002-09-01-api-查询国际化资源列表.md](system/2026-01-26-002-09-01-api-查询国际化资源列表.md) - 查询国际化资源列表接口
- [2026-01-26-002-09-02-api-导出国际化资源.md](system/2026-01-26-002-09-02-api-导出国际化资源.md) - 导出国际化资源接口
- [2026-01-26-002-09-03-api-获取资源详细信息.md](system/2026-01-26-002-09-03-api-获取资源详细信息.md) - 获取资源详细信息接口
- [2026-01-26-002-09-04-api-新增国际化资源.md](system/2026-01-26-002-09-04-api-新增国际化资源.md) - 新增国际化资源接口
- [2026-01-26-002-09-05-api-修改国际化资源.md](system/2026-01-26-002-09-05-api-修改国际化资源.md) - 修改国际化资源接口
- [2026-01-26-002-09-06-api-删除国际化资源.md](system/2026-01-26-002-09-06-api-删除国际化资源.md) - 删除国际化资源接口
- [2026-01-26-002-01-api-通用国际化.md](common/2026-01-26-002-01-api-通用国际化.md) - 通用国际化接口 API
### 1. 认证模块 (auth)
负责 Salesforce 登录认证和会话管理。
- **目录**: [auth/](auth/)
- **Controller**: [DataISfLoginController](auth/DataISfLoginController/)
- **接口列表**:
- [do-login](auth/DataISfLoginController/0001-do-login.md) - 用户登录
- [logout](auth/DataISfLoginController/0002-logout.md) - 用户登出
- [current](auth/DataISfLoginController/0003-current.md) - 获取当前用户信息
- [auto-login](auth/DataISfLoginController/0004-auto-login.md) - 自动登录（使用最新历史）
- [query-success-login-history](auth/DataISfLoginController/0005-query-success-login-history.md) - 查询不同类型ORG成功登录历史
- [auto-login-by-history](auth/DataISfLoginController/0006-auto-login-by-history.md) - 根据登录历史自动登录
### 2. 集成模块 (integration)
负责 Salesforce 数据同步、对象管理、元数据变更等核心功能。
- **目录**: [integration/](integration/)
- **Controller 列表**:
- [DataiIntegrationApiCallLogController](integration/DataiIntegrationApiCallLogController/) - API 调用日志管理
- [DataiIntegrationBatchController](integration/DataiIntegrationBatchController/) - 批次数据管理
- [DataiIntegrationBatchHistoryController](integration/DataiIntegrationBatchHistoryController/) - 批次历史记录
- [DataiIntegrationFieldController](integration/DataiIntegrationFieldController/) - 字段管理
- [DataiIntegrationFilterLookupController](integration/DataiIntegrationFilterLookupController/) - 过滤器查询管理
- [DataiIntegrationMetadataChangeController](integration/DataiIntegrationMetadataChangeController/) - 元数据变更管理
- [DataiIntegrationObjectController](integration/DataiIntegrationObjectController/) - 对象同步控制
- [DataiIntegrationPicklistController](integration/DataiIntegrationPicklistController/) - 选项列表管理
- [DataiIntegrationRateLimitController](integration/DataiIntegrationRateLimitController/) - 限流配置管理
- [DataiIntegrationRealtimeSyncController](integration/DataiIntegrationRealtimeSyncController/) - 实时同步管理
- [DataiIntegrationSyncLogController](integration/DataiIntegrationSyncLogController/) - 同步日志管理
- [RealtimeServiceController](integration/RealtimeServiceController/) - 实时服务管理
### 3. 监控模块 (monitor)
负责定时任务和任务日志的监控管理。
- **目录**: [monitor/](monitor/)
- **Controller 列表**:
- [SysJobController](monitor/SysJobController/) - 定时任务管理
- [SysJobLogController](monitor/SysJobLogController/) - 任务日志管理
### 4. 设置模块 (setting)
负责系统配置、环境管理、快照管理等设置功能。
- **目录**: [setting/](setting/)
- **Controller 列表**:
- [DataiConfigAuditLogController](setting/DataiConfigAuditLogController/) - 配置审计日志
- [DataiConfigEnvironmentController](setting/DataiConfigEnvironmentController/) - 配置环境管理
- [DataiConfigSnapshotController](setting/DataiConfigSnapshotController/) - 配置快照管理
- [DataiConfigurationController](setting/DataiConfigurationController/) - 系统配置管理
### 5. 文件模块 (file)
负责文件存储、文件信息管理、文件上传下载等功能。
- **目录**: [file/](file/)
- **模块索引**: [file/index.md](file/index.md) - 文件模块 API 文档索引（唯一真源）
- **Controller 列表**:
- [FileController](file/FileController/) - 文件存储服务
- [SysFileInfoController](file/SysFileInfoController/) - 文件信息管理
### 6. 定时任务模块 (task)
负责自动化数据同步、插入、更新和系统维护等定时任务。
- **目录**: [task/](task/)
- **任务列表**:
- [ObjectSyncTask](task/ObjectSyncTask.md) - 对象自动同步任务
- [ObjectInsertTask](task/ObjectInsertTask.md) - 对象自动插入任务
- [ObjectUpdateTask](task/ObjectUpdateTask.md) - 对象自动更新任务
- [MetadataChangeAutoSyncTask](task/MetadataChangeAutoSyncTask.md) - 元数据变更自动同步任务
- [RateLimitResetTask](task/RateLimitResetTask.md) - 每日限流重置任务
## 文档模板
- **模板文件**: [0000-template.md](0000-template.md)
- **用途**: 创建新的 API 文档时使用此模板
## 快速导航
### 常用接口
- **文件上传**: [统一上传接口](file/FileController/0002-upload.md)
- **文件下载**: [统一下载接口](file/FileController/0003-download.md)
- **文件预览**: [统一预览接口](file/FileController/0004-preview.md)
- **文件信息查询**: [查询文件列表](file/SysFileInfoController/0001-list.md)
- **对象同步**: [同步单个对象数据](integration/DataiIntegrationObjectController/0008-sync-single-object-data.md)
- **对象插入**: [插入对象数据到目标系统](integration/DataiIntegrationObjectController/0012-query-insert-progress.md)
- **对象更新**: [更新对象数据到目标系统](integration/DataiIntegrationObjectController/0014-query-update-progress.md)
- **元数据同步**: [同步元数据变更到本地数据库](integration/DataiIntegrationMetadataChangeController/0007-sync-to-local.md)
- **实时同步**: [启动实时同步](integration/DataiIntegrationRealtimeSyncController/0002-start-realtime-sync.md)
- **登录认证**: [用户登录](auth/DataISfLoginController/0001-do-login.md)
- **登录历史查询**: [查询不同类型ORG成功登录历史](auth/DataISfLoginController/0005-query-success-login-history.md)
- **历史自动登录**: [根据登录历史自动登录](auth/DataISfLoginController/0006-auto-login-by-history.md)
### 定时任务
- **对象同步**: [ObjectSyncTask](task/ObjectSyncTask.md) - 每天凌晨2点执行
- **对象插入**: [ObjectInsertTask](task/ObjectInsertTask.md) - 每天凌晨3点执行
- **对象更新**: [ObjectUpdateTask](task/ObjectUpdateTask.md) - 每天凌晨4点执行
- **元数据同步**: [MetadataChangeAutoSyncTask](task/MetadataChangeAutoSyncTask.md) - 每小时执行
- **限流重置**: [RateLimitResetTask](task/RateLimitResetTask.md) - 每天凌晨0点执行
## 维护指南
### 添加新 API 文档
1. 在对应的 Controller 目录下创建新的文档文件
2. 使用 [0000-template.md](0000-template.md) 作为模板
3. 按照模板格式填写接口信息
4. 更新对应的 Controller 索引文件（如果存在）
5. 更新本索引文件（如果是新的 Controller）
### 添加新定时任务文档
1. 在 [task/](task/) 目录下创建新的任务文档
2. 参考 [task/index.md](task/index.md) 中的格式
3. 更新 [task/index.md](task/index.md) 添加新任务的链接
4. 更新本索引文件添加新任务的链接
### 更新现有文档
1. 修改对应的文档文件
2. 更新文档中的"最后更新"日期
3. 如果有重大变更，更新相关的需求文档、架构决策和变更记录
## 相关文档
- [项目文档索引](../index.md) - 项目整体文档索引
- [需求文档](../requirements/) - 功能需求文档
- [架构决策](../decisions/adr/) - 架构决策记录
- [变更记录](../changelog/) - 项目变更记录
## 文档规范
### 命名规范
- API 文档：`{序号}-{接口名称}.md`（如：0001-do-login.md）
- 任务文档：`{任务名称}.md`（如：ObjectSyncTask.md）
- 索引文件：`index.md`
### 格式规范
- 使用 Markdown 格式
- 遵循 [0000-template.md](0000-template.md) 的结构
- 包含接口信息、功能描述、请求参数、响应数据、接口示例等
- 提供详细的错误处理和注意事项
### 版本管理
- 每次更新文档时，更新"最后更新"日期
- 重大变更时，更新版本号
- 保留历史版本的变更记录
## 联系方式
如有文档相关问题，请联系项目维护团队。
Reference in New Issue View Git Blame Copy Permalink