返回 AiToEarn
README.md
1 # Config Editor API
2
3 配置管理接口模块,对接后端 `config-editor` 控制器。
4
5 ## 文件清单
6
7 | 文件 | 说明 |
8 | ------------------------ | ------------------------------------------------------------ |
9 | `config-editor.api.ts` | 按服务目标获取配置、校验配置、保存配置、重启服务、恢复检查。 |
10 | `config-editor.types.ts` | 配置文件格式、服务目标、配置响应与请求类型。 |
11
12 ## 接口清单
13
14 | 方法 | 路径 | 说明 |
15 | --------------------------------- | --------------------------------------------- | ------------------------------------ |
16 | `getConfigEditorConfigApi` | `GET config` / `GET ai/config` | 获取指定服务配置对象与配置文件格式。 |
17 | `validateConfigEditorConfigApi` | `POST config/validate` / `ai/config/validate` | 校验指定服务配置对象。 |
18 | `saveConfigEditorConfigApi` | `PUT config` / `PUT ai/config` | 保存指定服务配置对象。 |
19 | `restartConfigEditorServiceApi` | `POST config/restart` / `ai/config/restart` | 重启指定服务。 |
20 | `checkConfigEditorConfigReadyApi` | `GET v2/channels/accounts` / `GET ai/config` | 按服务目标确认服务接口是否恢复可用。 |
21
22 ## 维护规则
23
24 - 请求方法与类型定义保持分离。
25 - 配置编辑 UI 不直接调用 `fetch` 访问业务接口,统一通过本目录 API。
26 - 主服务重启后使用账号列表接口确认业务 API 恢复,避免轮询旧健康检查接口。
27 - AI 服务配置入口通过网关路径 `ai/config` 访问,重启后使用带鉴权的配置读取确认恢复。
28
28 lines MARKDOWN