From c74a430ab8c9f20336fdce2dcd1ca0124e53c2e3 Mon Sep 17 00:00:00 2001 From: clz Date: Sun, 11 Jan 2026 19:53:55 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20README=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 添加版本徽章 (1.0.0) - 补充完整 API 文档(认证、账单查询、统计等) - 添加认证相关环境变量说明 - 更新路线图,标记已完成功能 - 更新项目结构,添加登录页和状态管理 --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a45f6a..903f76c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ 一个基于微服务架构的个人账单分析工具,支持微信和支付宝账单的自动解析、智能分类和可视化分析。 +![版本](https://img.shields.io/badge/版本-1.0.0-green) ![架构](https://img.shields.io/badge/架构-微服务-blue) ![Go](https://img.shields.io/badge/Go-1.21-00ADD8) ![Python](https://img.shields.io/badge/Python-3.12-3776AB) @@ -94,11 +95,13 @@ BillAI/ ├── web/ # 前端 (SvelteKit + TailwindCSS) │ ├── src/ │ │ ├── routes/ # 页面路由 +│ │ │ ├── login/ # 🔐 登录页面 │ │ │ ├── analysis/ # 📊 账单分析页 │ │ │ ├── bills/ # 📋 账单列表页 │ │ │ └── review/ # ✅ 复核页面 │ │ └── lib/ │ │ ├── components/ # UI 组件 +│ │ ├── stores/ # 状态管理 │ │ └── services/ # API 服务 │ └── Dockerfile │ @@ -189,8 +192,14 @@ python server.py | 方法 | 路径 | 说明 | |------|------|------| +| `POST` | `/api/auth/login` | 用户登录 | +| `GET` | `/api/auth/validate` | 验证 Token | | `POST` | `/api/upload` | 上传并分析账单 | +| `GET` | `/api/bills` | 查询账单列表 | +| `POST` | `/api/bills/manual` | 手动录入账单 | | `GET` | `/api/review` | 获取待复核记录 | +| `GET` | `/api/review-stats` | 待复核统计 | +| `GET` | `/api/monthly-stats` | 月度统计 | | `GET` | `/health` | 健康检查 | ### 分析服务 API (Python) @@ -213,6 +222,10 @@ python server.py | `ANALYZER_MODE` | `http` | 适配器模式: http/subprocess | | `MONGO_URI` | `mongodb://localhost:27017` | MongoDB 连接 URI | | `MONGO_DATABASE` | `billai` | 数据库名称 | +| `JWT_SECRET` | - | JWT 加密密钥 | +| `TOKEN_EXPIRY` | `24` | Token 过期时间(小时) | +| `ADMIN_USERNAME` | - | 管理员用户名(可选) | +| `ADMIN_PASSWORD` | - | 管理员密码(可选) | ### 配置文件 @@ -236,7 +249,9 @@ python server.py ## 🛣️ 路线图 -- [ ] 添加用户认证 (JWT) +- [x] 添加用户认证 (JWT) +- [x] 手动录入账单 +- [x] 数据分析图表 - [ ] 支持更多账单格式(银行账单) - [ ] AI 智能分类(LLM) - [ ] 预算管理功能