34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# WOV Echo Node
|
|
|
|
本仓库是 WOV 平台的示例节点，用于验证节点协议、独立 Git 管理和生命周期回收。
|
|
|
|
## 启动
|
|
|
|
```powershell
|
|
uv run python -m wov_node_echo
|
|
```
|
|
|
|
启动后打印 `WOV_NODE_READY port=<port>`，由 `wov-api` 的节点管理器读取并执行健康检查。
|
|
|
|
## 节点协议
|
|
|
|
- `GET /health`：返回节点是否就绪。
|
|
- `POST /invoke`：接收 `InvokeRequest`，返回 `InvokeResponse`。
|
|
|
|
## 约束
|
|
|
|
- 本节点不包含平台 API 或其他节点的业务逻辑。
|
|
- 输入输出通过 URI 传递，节点进程自身无持久状态。
|
|
|
|
## 环境
|
|
|
|
- Python 环境统一使用 uv 管理。
|
|
- 测试必须达到 100% 行覆盖率，且只能通过调用真实代码路径覆盖。
|
|
|
|
## 代码注释规范
|
|
|
|
- 本仓库所有源码（Python、TOML 等支持注释的文件）必须配有详细中文注释，说明模块职责、核心函数的作用以及关键逻辑，确保后续维护人员可以快速理解代码工作原理。
|
|
- 新增或修改代码时，必须同步补充或更新对应注释；不得删除已有注释。
|
|
- 测试代码同样必须配有中文注释，说明每条测试验证的行为。
|
|
- JSON 数据文件（`node.manifest.json`）不支持注释，字段语义以 `wov-sdk` 的 `NodeManifest` 模型注释和本文档输入/输出说明为准。
|