Simon
facc04aa65
本提交为 .git 对象库损坏后的重建提交，内容等价于原先三个本地提交 （5e2fd4c2 / 57a53c98 / 5d7e1873）的累积结果，未做任何额外改动。 一、docs 结构整改（整改 #14） 根因：重构时新结构为 untracked 文件，执行 git stash（未带 -u）未纳入， 随后 git reset 拉回 HEAD 旧 tracked 树，导致旧树复活、新旧两棵目录 树并存于 docs/，共 791 文件、双分类体系冲突。 修复动作： - b2 同名异主题文件改名迁移保全 9 个 - C 类 39 个孤立文件按主题正确归类 - A/B1 类 222 个重复文件删除（新结构已有内容副本） - 9 个旧独有空目录删除 - 270 处内部引用按 verified 映射改写 - 整改记录 #14 登记于 04-运维文档/部署运维 结果：docs 791 → 569 文件，顶层仅规范 8 类 + 治理文件，单树恢复。 残留：约 20 处指向从未存在文件的陈旧死链，归入独立文档卫生任务。 二、compose 双目录对齐（消除踩坑 A） - docker-compose.yml：nginx 前端挂载全部由根目录 frontend-*/dist 改为 src/frontend-*/dist（h5 / agent / admin / terminal） - docker-compose.dev.yml：dev 服务 build context 与卷同步改 src/ - 效果：本地 docker compose up 不再把根目录 stale dist 挂回， 与线上一致，分叉隐患消除（已 docker compose config 校验通过） 防复发铁律： - 重构须提交；仓库修复须 git stash -u 或先 commit - 新结构须 git add 并提交，避免再次 untracked 复活 - H5 改动只动 src/frontend-h5/，禁改根目录遗留 frontend-*/
135 lines
3.7 KiB
Markdown
135 lines
3.7 KiB
Markdown
# 任务说明书：火绒API集成
|
||
|
||
> **版本**: v1.0 | **日期**: 2026-07-20
|
||
> **关联需求编号**: REQ-集成-001
|
||
|
||
---
|
||
|
||
## 📋 基本信息
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **任务名称** | 火绒API集成 - 终端列表与软件列表获取 |
|
||
| **任务ID** | #118 |
|
||
| **优先级** | 🔴P0 |
|
||
| **类型** | 功能开发 |
|
||
| **状态** | ✅ 无需开发（功能已存在） |
|
||
| **负责人** | 待定 |
|
||
| **创建日期** | 2026-07-20 |
|
||
| **计划完成日期** | 2026-07-21 |
|
||
|
||
---
|
||
|
||
> ⚠️ **重要说明**：火绒 API 集成功能已存在于系统中，本任务无需开发。
|
||
>
|
||
> **现有功能**：
|
||
> - `GET /api/admin/integrations/huorong/terminals` - 获取终端列表
|
||
> - `GET /api/admin/integrations/huorong/terminals/{client_id}` - 获取终端详情（含软件列表）
|
||
> - `POST /api/admin/integrations/huorong/test` - 测试连接
|
||
>
|
||
> **代码位置**：`app/integrations/huorong/`
|
||
>
|
||
> **本期只需**：确认现有 API 满足 OpenClaw 检测需求（通过 `_info2` 接口获取软件列表）
|
||
|
||
---
|
||
|
||
## 📥 输入项来源
|
||
|
||
### 产品需求
|
||
| 来源文档 | 相关章节 | 说明 |
|
||
|----------|----------|------|
|
||
| `01-产品文档/08-集成生态/PRD-REQ-集成-001-OpenClaw合规检查-v1.0.md` | §5.1 T1 | REQ-001-01, REQ-001-02 |
|
||
|
||
### 技术架构
|
||
| 来源文档 | 相关章节 | 说明 |
|
||
|----------|----------|------|
|
||
| `02-技术文档/实现配置/技术方案-REQ-集成-001-OpenClaw合规检查-v1.0.md` | - | 待创建 |
|
||
|
||
### 原型设计
|
||
| 来源文档 | 页面 | 说明 |
|
||
|----------|------|------|
|
||
| `01-产品文档/08-集成生态/原型-REQ-集成-001-OpenClaw合规检查-v1.0.html` | 数据源管理 | 火绒API配置页面 |
|
||
|
||
---
|
||
|
||
## 📤 输出成果要求
|
||
|
||
### 交付物清单
|
||
|
||
| # | 交付物 | 类型 | 说明 |
|
||
|---|--------|------|------|
|
||
| 1 | 火绒API客户端封装 | 代码 | Python模块封装火绒API调用 |
|
||
| 2 | 终端列表接口 | API | GET /api/integration/huorong/clients |
|
||
| 3 | 终端软件列表接口 | API | GET /api/integration/huorong/software/{client_id} |
|
||
| 4 | API配置管理界面 | 前端 | 火绒服务器地址、API Key配置 |
|
||
|
||
### 代码要求
|
||
- 遵循项目代码规范
|
||
- 所有新增代码通过 Pylint 检查
|
||
|
||
### 文档要求
|
||
- 更新API接口文档
|
||
- 更新部署文档（如有变更）
|
||
|
||
---
|
||
|
||
## 🔧 验证方式
|
||
|
||
### 功能验证
|
||
| 验证项 | 验证方法 | 预期结果 |
|
||
|--------|----------|-----------|
|
||
| 获取终端列表 | 调用API | 返回终端基本信息 |
|
||
| 获取软件列表 | 调用API | 返回终端已安装软件 |
|
||
| API配置保存 | 前端配置 | 配置持久化成功 |
|
||
|
||
---
|
||
|
||
## ✅ 完成标准
|
||
|
||
- [ ] 火绒API客户端模块开发完成
|
||
- [ ] 终端列表接口开发完成
|
||
- [ ] 终端软件列表接口开发完成
|
||
- [ ] API配置界面开发完成
|
||
- [ ] 本地测试通过
|
||
|
||
---
|
||
|
||
## 📊 工作分解
|
||
|
||
### 子任务
|
||
|
||
| 子任务 | 负责人 | 预估工时 | 状态 |
|
||
|--------|--------|----------|------|
|
||
| 火绒API客户端封装 | - | 0.5人天 | 待开始 |
|
||
| 终端列表API开发 | - | 0.5人天 | 待开始 |
|
||
| 终端软件列表API开发 | - | 0.5人天 | 待开始 |
|
||
| 前端配置界面 | - | 0.5人天 | 待开始 |
|
||
|
||
---
|
||
|
||
## 📞 依赖与阻塞
|
||
|
||
### 前置依赖
|
||
| 依赖任务 | 依赖说明 | 状态 |
|
||
|----------|----------|------|
|
||
| 无 | - | - |
|
||
|
||
### 阻塞因素
|
||
| 阻塞项 | 影响范围 | 解决方案 |
|
||
|--------|----------|-----------|
|
||
| 火绒API凭证 | 无法调用API | 联系IT获取API Key |
|
||
|
||
---
|
||
|
||
## 📈 变更记录
|
||
|
||
| 日期 | 变更内容 | 变更人 | 说明 |
|
||
|------|----------|--------|------|
|
||
| 2026-07-20 | 创建任务 | Simon | 初始版本 |
|
||
|
||
---
|
||
|
||
## 📎 附件
|
||
|
||
- PRD文档: `01-产品文档/08-集成生态/PRD-REQ-集成-001-OpenClaw合规检查-v1.0.md`
|