datai/datai-scenes/datai-scene-salesforce/docs/api-docs/index.md

# API 文档索引

## 概述

本目录包含 Salesforce 集成系统的所有 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) 的结构
- 包含接口信息、功能描述、请求参数、响应数据、接口示例等
- 提供详细的错误处理和注意事项

### 版本管理

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

## 联系方式

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