kris/datai

- 新增 4 个定时任务类：
  - ObjectSyncTask: 对象自动同步任务
  - ObjectInsertTask: 对象自动插入任务
  - ObjectUpdateTask: 对象自动更新任务
  - MetadataChangeAutoSyncTask: 元数据变更自动同步任务

- 新增 2 个多对象操作接口：
  - insertMultipleObjectDataToTarget: 批量插入对象数据到目标系统
  - updateMultipleObjectDataToTarget: 批量更新对象数据到目标系统

- 新增完整的定时任务文档：
  - task/index.md: 定时任务文档索引
  - ObjectSyncTask.md: 对象自动同步任务文档
  - ObjectInsertTask.md: 对象自动插入任务文档
  - ObjectUpdateTask.md: 对象自动更新任务文档
  - MetadataChangeAutoSyncTask.md: 元数据变更自动同步任务文档
  - RateLimitResetTask.md: 每日限流重置任务文档

- 新增 API 文档索引：api-docs/index.md

- 更新唯一真源文档中心：docs/index.md

- 新增完整的项目文档：
  - REQ-005.md: 定时任务自动同步、插入和更新对象数据需求
  - REQ-006.md: 元数据变更自动同步本地数据库需求
  - 0005-scheduled-tasks-implementation.md: 定时任务架构决策
  - 0006-metadata-change-auto-sync.md: 元数据变更自动同步架构决策
  - 005-scheduled-tasks-implementation.md: 定时任务实现提示词
  - 006-metadata-change-auto-sync.md: 元数据变更自动同步实现提示词
  - 20260116-scheduled-tasks-implementation.md: 定时任务实现会话记录
  - 20260116-metadata-change-auto-sync.md: 元数据变更自动同步实现会话记录
  - 20260116-scheduled-tasks-implementation-retro.md: 定时任务实现复盘
  - 20260116-metadata-change-auto-sync-retro.md: 元数据变更自动同步实现复盘
  - 0015-scheduled-tasks-implementation.md: 定时任务变更记录
  - 0016-metadata-change-auto-sync.md: 元数据变更自动同步变更记录

- 更新 CHANGELOG.md 和 README.md

2026-01-16 16:38:35 +08:00

6.4 KiB

Raw Blame History

API 文档索引

概述

本目录包含 Salesforce 集成系统的所有 API 文档，按模块分类组织。

模块列表

1. 认证模块 (auth)

负责 Salesforce 登录认证和会话管理。

目录: auth/
Controller: DataISfLoginController
接口列表:
- do-login - 用户登录
- logout - 用户登出
- current - 获取当前用户信息
- auto-login - 自动登录

2. 集成模块 (integration)

负责 Salesforce 数据同步、对象管理、元数据变更等核心功能。

目录: integration/
Controller 列表:
- DataiIntegrationApiCallLogController - API 调用日志管理
- DataiIntegrationBatchController - 批次数据管理
- DataiIntegrationBatchHistoryController - 批次历史记录
- DataiIntegrationFieldController - 字段管理
- DataiIntegrationFilterLookupController - 过滤器查询管理
- DataiIntegrationMetadataChangeController - 元数据变更管理
- DataiIntegrationObjectController - 对象同步控制
- DataiIntegrationPicklistController - 选项列表管理
- DataiIntegrationRateLimitController - 限流配置管理
- DataiIntegrationRealtimeSyncController - 实时同步管理
- DataiIntegrationSyncLogController - 同步日志管理
- RealtimeServiceController - 实时服务管理

3. 监控模块 (monitor)

负责定时任务和任务日志的监控管理。

目录: monitor/
Controller 列表:
- SysJobController - 定时任务管理
- SysJobLogController - 任务日志管理

4. 设置模块 (setting)

负责系统配置、环境管理、快照管理等设置功能。

目录: setting/
Controller 列表:
- DataiConfigAuditLogController - 配置审计日志
- DataiConfigEnvironmentController - 配置环境管理
- DataiConfigSnapshotController - 配置快照管理
- DataiConfigurationController - 系统配置管理

5. 定时任务模块 (task)

负责自动化数据同步、插入、更新和系统维护等定时任务。

目录: task/
任务列表:
- ObjectSyncTask - 对象自动同步任务
- ObjectInsertTask - 对象自动插入任务
- ObjectUpdateTask - 对象自动更新任务
- MetadataChangeAutoSyncTask - 元数据变更自动同步任务
- RateLimitResetTask - 每日限流重置任务

文档模板

模板文件: 0000-template.md
用途: 创建新的 API 文档时使用此模板

快速导航

常用接口

对象同步: 同步单个对象数据
对象插入: 插入对象数据到目标系统
对象更新: 更新对象数据到目标系统
元数据同步: 同步元数据变更到本地数据库
实时同步: 启动实时同步

定时任务

对象同步: ObjectSyncTask - 每天凌晨2点执行
对象插入: ObjectInsertTask - 每天凌晨3点执行
对象更新: ObjectUpdateTask - 每天凌晨4点执行
元数据同步: MetadataChangeAutoSyncTask - 每小时执行
限流重置: RateLimitResetTask - 每天凌晨0点执行

维护指南

添加新 API 文档

在对应的 Controller 目录下创建新的文档文件
使用 0000-template.md 作为模板
按照模板格式填写接口信息
更新对应的 Controller 索引文件（如果存在）
更新本索引文件（如果是新的 Controller）

添加新定时任务文档

在 task/ 目录下创建新的任务文档
参考 task/index.md 中的格式
更新 task/index.md 添加新任务的链接
更新本索引文件添加新任务的链接

更新现有文档

修改对应的文档文件
更新文档中的"最后更新"日期
如果有重大变更，更新相关的需求文档、架构决策和变更记录

文档规范

命名规范

API 文档：{序号}-{接口名称}.md（如：0001-do-login.md）
任务文档：{任务名称}.md（如：ObjectSyncTask.md）
索引文件：index.md

格式规范

使用 Markdown 格式
遵循 0000-template.md 的结构
包含接口信息、功能描述、请求参数、响应数据、接口示例等
提供详细的错误处理和注意事项

版本管理

每次更新文档时，更新"最后更新"日期
重大变更时，更新版本号
保留历史版本的变更记录

联系方式

如有文档相关问题，请联系项目维护团队。

6.4 KiB Raw Blame History Unescape Escape