Bladeren bron

docs: 同步API默认密码、任务返回及客户端实现细节

yangkaixiang 1 maand geleden
bovenliggende
commit
e77b0b4130
3 gewijzigde bestanden met toevoegingen van 54 en 13 verwijderingen
  1. 17 1
      docs/03-通信与HTTP_API.md
  2. 30 12
      docs/04-客户端流程与MVP.md
  3. 7 0
      docs/05-Agent模块设计.md

+ 17 - 1
docs/03-通信与HTTP_API.md

@@ -53,9 +53,14 @@ Base URL:
 
 ```http
 Content-Type: application/json
-X-Admin-Password: 固定初始化密码
+X-Admin-Password: Dt123$
 ```
 
+当前实现说明:
+
+1. 默认管理密码为 `Dt123$`
+2. 也可通过 `--password` 启动参数覆盖
+
 ## 2. 通用约定
 
 ### 2.1 通用响应格式
@@ -306,6 +311,12 @@ X-Admin-Password: 固定初始化密码
 }
 ```
 
+说明:
+
+1. 当前 `apply` 返回的是“任务创建结果”
+2. 返回数据只包含 `interface` 和 `task_id`
+3. 任务详细状态需再调用 `GET /api/tasks/{task_id}` 获取
+
 执行流程:
 
 1. 校验参数
@@ -463,3 +474,8 @@ X-Admin-Password: 固定初始化密码
 3. 校验密码是否正确
 4. 通过后进入业务逻辑
 5. 返回统一 JSON 响应
+
+当前实现补充:
+
+1. 已增加 HTTP 访问日志
+2. 日志会记录方法、路径、查询参数、状态码和耗时

+ 30 - 12
docs/04-客户端流程与MVP.md

@@ -22,15 +22,34 @@
 
 ## 2. Windows 客户端流程
 
+### 当前实现状态
+
+当前实现已经收敛为以下结构:
+
+1. 主窗口:负责本机网卡选择、密码输入、直连探测、切换到维护网络、发现并连接
+2. 设备详情弹窗:负责设备信息、目标接口选择、当前配置读取、新配置填写、校验、应用、任务轮询
+
+当前实现与早期设计相比有以下变化:
+
+1. 密码默认自动保存到注册表,不再提供“记住密码”复选框
+2. 密码框提供显示/隐藏切换
+3. 设备信息与 Linux 接口不再常驻主窗口,改为连接成功后弹窗显示
+4. 配置区的 `1/2/3` 步骤已直接放到按钮文案里
+
 ### 2.0 页面结构建议
 
-首版建议采用 4 个主界面:
+早期设计建议采用 4 个主界面:
 
 1. 连接页
 2. 设备页
 3. 配置页
 4. 结果页
 
+当前实现已收敛为:
+
+1. 连接主窗口
+2. 设备详情与配置弹窗
+
 ### 2.0.1 连接页
 
 页面目标:
@@ -48,16 +67,16 @@
    - 链路状态
    - 当前 IPv4
 3. 密码输入框
-4. 记住密码复选框
+4. 密码显示/隐藏切换
 5. 按钮:`切换到维护网络`
 6. 按钮:`发现并连接`
-7. 发现结果区域
+7. 运行日志区域
 
 交互规则:
 
 1. 若本地已保存密码,页面打开时自动填充
 2. 用户可修改密码后重新保存
-3. 发现成功后自动进入设备页
+3. 发现成功后自动弹出设备详情与配置窗口
 
 #### 连接页详细交互
 
@@ -118,7 +137,7 @@
 3. 仅在用户勾选 `记住密码` 且连接成功后写入
 4. 用户点击 `清除已保存密码` 时删除该值
 
-### 2.0.2 设备
+### 2.0.2 设备详情弹窗
 
 页面目标:
 
@@ -488,10 +507,9 @@
 
 ### 4.2 建议实现
 
-1. 客户端提供 `记住密码` 复选框
-2. 用户勾选后,将密码安全保存到 Windows 本机
-3. 下次打开客户端时自动读取并填充
-4. 用户可手动清除已保存密码
+1. 客户端默认自动保存密码到 Windows 本机
+2. 下次打开客户端时自动读取并填充
+3. 用户修改密码后,新值自动覆盖旧值
 
 ### 4.3 存储方式
 
@@ -501,15 +519,15 @@
 
 1. 将密码保存到当前用户范围的注册表项
 2. 客户端启动时自动读取该值并填充
-3. 用户取消 `记住密码` 时删除该注册表项
+3. 当前不提供界面内删除密码按钮
 4. 后续如需提升安全性,再升级为受保护存储方式
 
 ### 4.4 交互规则
 
 1. 若已保存密码,连接页自动带出
 2. 用户仍可修改密码
-3. 新密码连接成功后,若勾选 `记住密码`,则覆盖旧密码
-4. 若连续出现密码错误,应提示用户检查或清除本地保存密码
+3. 新密码在连接或配置动作发生时自动覆盖旧密码
+4. 若连续出现密码错误,应提示用户检查当前密码是否与 Agent 启动参数一致
 5. 需在文档和实现中明确:当前阶段密码保存在注册表中,为便捷优先方案
 
 ## 5. MVP 范围

+ 7 - 0
docs/05-Agent模块设计.md

@@ -128,6 +128,7 @@
 
 1. 暂时取消来源 IP 限制
 2. 仅保留密码校验
+3. 当前默认密码为 `Dt123$`
 
 边界:
 
@@ -285,6 +286,12 @@
 5. `rolling_back`
 6. `completed`
 
+当前实现补充:
+
+1. `POST /api/network/apply` 返回的是任务创建结果,而不是完整任务详情
+2. 当前返回数据只包含 `interface` 和 `task_id`
+3. 任务详细状态需要再通过 `GET /api/tasks/{task_id}` 获取
+
 ### 3.15 系统控制模块
 
 建议名称:`systemctl` 或 `systemops`