kris/datai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
develop
datai/docs/archive/api-docs/index.md

19 KiB
Raw Permalink Blame History

API 文档索引

概述

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

模块列表

1. 认证模块 (auth)

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

2. 集成模块 (integration)

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

3. 监控模块 (monitor)

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

4. 设置模块 (setting)

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

5. 文件模块 (file)

负责文件存储、文件信息管理、文件上传下载等功能。

6. 定时任务模块 (task)

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

文档模板

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

快速导航

常用接口

定时任务

维护指南

添加新 API 文档

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

添加新定时任务文档

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

更新现有文档

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

相关文档

文档规范

命名规范

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

格式规范

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

版本管理

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

联系方式

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