Sfoglia il codice sorgente

docs: 完善 README,移除 API 接口部分改为引用独立 API 文档

moki 2 settimane fa
parent
commit
e02cf1d153
1 ha cambiato i file con 4 aggiunte e 32 eliminazioni
  1. 4 32
      README.md

+ 4 - 32
README.md

@@ -8,8 +8,8 @@ OpenCode 状态监控工具,支持实时监控多个 OpenCode 实例的状态
 - 📊 **实时监控** - 通过 SSE 事件流实时获取状态变化
 - 📡 **MQTT 推送** - 支持将状态信息推送到 MQTT Broker
 - 💾 **配置管理** - 使用 SQLite 存储 MQTT 配置
-- 🌐 **HTTP API** - 提供 RESTful API 接口管理配置
-- 🔌 **WebSocket** - 支持通过 WebSocket 实时推送状态到网页
+- 🌐 **HTTP API** - 提供 RESTful API 接口管理配置(详见 [API 文档](docs/api.md))
+- 🔌 **WebSocket** - 支持通过 WebSocket 实时推送状态到网页(详见 [API 文档](docs/api.md))
 - 🖥️ **跨平台** - 支持 Linux、macOS、Windows
 
 ## 安装
@@ -63,6 +63,8 @@ make build-all
 ./opencode-monitor serve --addr :8080
 ```
 
+API 接口详情请参阅 [API 文档](docs/api.md)。
+
 ### 配置管理
 
 ```bash
@@ -79,36 +81,6 @@ make build-all
 ./opencode-monitor config delete 1
 ```
 
-## API 接口
-
-| 方法 | 路径 | 说明 |
-|------|------|------|
-| GET | /api/health | 健康检查 |
-| GET | /api/mqtt | 获取所有配置 |
-| POST | /api/mqtt | 创建配置 |
-| GET | /api/mqtt/:id | 获取单个配置 |
-| PUT | /api/mqtt/:id | 更新配置 |
-| DELETE | /api/mqtt/:id | 删除配置 |
-| GET | / | 状态监控页面 |
-| GET | /ws | WebSocket 连接 |
-
-### 请求示例
-
-```bash
-# 创建 MQTT 配置(无认证)
-curl -X POST http://localhost:8080/api/mqtt \
-  -H "Content-Type: application/json" \
-  -d '{"broker":"tcp://127.0.0.1:1883","topic":"opencode/status"}'
-
-# 创建 MQTT 配置(带认证)
-curl -X POST http://localhost:8080/api/mqtt \
-  -H "Content-Type: application/json" \
-  -d '{"broker":"tcp://127.0.0.1:1883","username":"user","password":"pass","topic":"opencode/status"}'
-
-# 获取所有配置
-curl http://localhost:8080/api/mqtt
-```
-
 ## MQTT 消息格式
 
 消息格式为 JSON: