Initial commit: 龙虾舰队监控中心

docs/API 文档.md

@@ -0,0 +1,123 @@
+# Django 后端 API 文档
+
+## 📋 API 接口
+
+### 基础 URL
+```
+http://localhost:8000/api
+```
+
+### 龙虾相关
+
+#### 获取所有龙虾状态
+```
+GET /api/lobsters/
+```
+
+**响应示例**:
+```json
+[
+  {
+    "id": 1,
+    "name": "飞行侠",
+    "emoji": "🦸",
+    "status": "healthy",
+    "specialty": "主力/通用",
+    "port": 18789,
+    "container": "openclaw-instance2"
+  }
+]
+```
+
+#### 获取单个龙虾详情
+```
+GET /api/lobsters/{id}/
+```
+
+### 记忆相关
+
+#### 获取记忆日期列表
+```
+GET /api/lobsters/{id}/memory/dates/
+```
+
+**响应示例**:
+```json
+{
+  "dates": ["2026-04-01", "2026-03-31", "2026-03-30"]
+}
+```
+
+#### 获取指定日期记忆
+```
+GET /api/lobsters/{id}/memory/{date}/
+```
+
+**响应示例**:
+```json
+{
+  "date": "2026-04-01",
+  "content": "# 2026-04-01 记忆\n\n..."
+}
+```
+
+### 搜索相关
+
+#### 全文检索
+```
+GET /api/lobsters/{id}/search/?q=关键词
+```
+
+**响应示例**:
+```json
+{
+  "results": [
+    {
+      "title": "文档标题",
+      "snippet": "包含关键词的片段...",
+      "url": "http://..."
+    }
+  ]
+}
+```
+
+### 工具相关
+
+#### 获取工具列表
+```
+GET /api/tools/
+```
+
+---
+
+## 🔧 开发说明
+
+### 技术栈
+- **后端**: Django 4.x
+- **数据库**: SQLite (开发) / PostgreSQL (生产)
+- **API**: Django REST Framework
+
+### 项目结构
+```
+backend/
+├── manage.py
+├── backend/
+│   ├── settings.py
+│   ├── urls.py
+│   └── wsgi.py
+├── api/              # API 接口
+├── lobsters/         # 龙虾管理
+├── memory/           # 记忆管理
+├── search/           # 搜索功能
+└── tools/            # 工具管理
+```
+
+### 运行后端
+```bash
+cd backend
+python manage.py runserver 0.0.0.0:8000
+```
+
+---
+
+**最后更新**: 2026-04-01