64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
|
# API 文档
|
|||
|
|
|
|||
|
|
## 目录用途
|
|||
|
|
存放项目的 API 相关文档，包括接口定义、请求响应示例、错误码等。
|
|||
|
|
|
|||
|
|
## 文档规范
|
|||
|
|
- 文档命名格式：YYYY-MM-DD-00X-api.md
|
|||
|
|
- 必须包含接口列表、请求参数、响应参数、示例
|
|||
|
|
- 支持交叉引用其他文档
|
|||
|
|
|
|||
|
|
## 文档列表
|
|||
|
|
|
|||
|
|
### 模板
|
|||
|
|
- [API 文档模板](./template.md) - 创建新 API 文档的标准模板
|
|||
|
|
|
|||
|
|
### API 文档
|
|||
|
|
|
|||
|
|
#### datai-admin
|
|||
|
|
*暂无文档*
|
|||
|
|
|
|||
|
|
#### datai-common
|
|||
|
|
*暂无文档*
|
|||
|
|
|
|||
|
|
#### datai-framework
|
|||
|
|
*暂无文档*
|
|||
|
|
|
|||
|
|
#### datai-models
|
|||
|
|
*暂无文档*
|
|||
|
|
|
|||
|
|
#### datai-plugins
|
|||
|
|
*暂无文档*
|
|||
|
|
|
|||
|
|
#### datai-scenes
|
|||
|
|
*暂无文档*
|
|||
|
|
|
|||
|
|
#### datai-system
|
|||
|
|
- [2026-01-21-001-api](./2026-01-21-001-api.md) - 动态数据源延迟加载 API 文档
|
|||
|
|
|
|||
|
|
## 使用指南
|
|||
|
|
|
|||
|
|
### 创建新 API 文档
|
|||
|
|
1. 复制 [template.md](./template.md) 作为基础
|
|||
|
|
2. 根据功能模块选择对应子目录：
|
|||
|
|
- `datai-admin` - 管理后台相关 API
|
|||
|
|
- `datai-common` - 通用组件相关 API
|
|||
|
|
- `datai-framework` - 框架核心相关 API
|
|||
|
|
- `datai-models` - 数据模型相关 API
|
|||
|
|
- `datai-plugins` - 插件系统相关 API
|
|||
|
|
- `datai-scenes` - 场景应用相关 API
|
|||
|
|
- `datai-system` - 系统管理相关 API
|
|||
|
|
3. 重命名为 `YYYY-MM-DD-00X-api.md` 格式
|
|||
|
|
4. 填充完整的 API 信息
|
|||
|
|
5. 更新本文档对应子目录的文档列表
|
|||
|
|
|
|||
|
|
### 文档要素
|
|||
|
|
每个 API 文档应包含：
|
|||
|
|
- 元数据（需求编号、创建时间、创建人、版本）
|
|||
|
|
- API 概述和基础信息
|
|||
|
|
- 端点列表（请求方式、路径、参数、响应）
|
|||
|
|
- 变更历史
|
|||
|
|
- 相关文档引用
|
|||
|
|
|
|||
|
|
## 返回主索引
|
|||
|
|
[返回项目单一真源](../index.md)
|