Skip to content

Commit fa9f33e

Browse files
committed
更新2.0.0版本readme
1 parent b865f1c commit fa9f33e

File tree

6 files changed

+281
-47
lines changed

6 files changed

+281
-47
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ app.log
1414
data\
1515
data/
1616
wxautox_activation.json
17+
wxauto_qrcode
1718

1819
# C extensions
1920
*.so

README.md

Lines changed: 222 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<div align="center">
44

5-
![Version](https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000)
5+
![Version](https://img.shields.io/badge/version-2.0.0-blue.svg?cacheSeconds=2592000)
66
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
77
![Platform](https://img.shields.io/badge/platform-Windows-lightgrey.svg)
88
![Python](https://img.shields.io/badge/python-3.7%2B-blue.svg)
@@ -22,13 +22,22 @@
2222

2323
## ✨ 功能特点
2424

25+
### 🎯 2.0.0 版本重大更新
26+
- 🚀 **30+ API接口**:全面覆盖微信自动化各个场景,API数量大幅增加
27+
- 🔧 **增强稳定性**:解决异步任务冲突,完善错误处理机制
28+
- 📚 **集成API文档**:内置完整的API文档系统和在线测试工具
29+
- 🔄 **集成最新wxauto/x V2版本**:支持wxauto v39.1.8 和 wxautox v39.1.36
30+
31+
### 🌟 核心功能
2532
- 📱 **内置wxauto微信自动化库**:作为核心依赖直接集成,开箱即用
2633
- 🚀 **内置wxautox扩展功能**:增强版微信自动化库,提供更强大的功能和更高的稳定性
27-
- 🌐 **完整的HTTP API接口**:简单易用的RESTful API
28-
- 💬 **丰富的消息功能**:支持文本、图片、文件、视频等多种消息类型
29-
- 👥 **群聊和好友管理**:支持群聊创建、成员管理、好友添加等功能
30-
- 🔄 **实时消息监听**:支持实时获取新消息
31-
- 🖥️ **图形化管理界面**:提供直观的服务管理和配置界面
34+
- 🌐 **完整的HTTP API接口**:简单易用的RESTful API,支持所有微信操作
35+
- 💬 **丰富的消息功能**:支持文本、图片、文件、视频、语音等多种消息类型
36+
- 👥 **群聊和好友管理**:支持群聊创建、成员管理、好友添加、申请处理等功能
37+
- 🌍 **朋友圈管理**:支持朋友圈发布、查看、互动等操作(Plus版)
38+
- 🔐 **自动登录功能**:支持二维码登录和自动登录管理
39+
- 🔄 **实时消息监听**:支持实时获取新消息和多对象监听
40+
- 🖥️ **图形化管理界面**:提供直观的服务管理、配置和日志监控功能
3241
- 🔑 **智能激活管理**:自动保存和管理wxautox激活码
3342
- 📦 **一体化打包**:所有依赖库都打包在可执行文件中,无需额外安装
3443

@@ -144,20 +153,36 @@ start_api.bat
144153

145154
### 📚 API接口说明
146155

156+
#### 🔑 认证方式
147157
所有API请求都需要在请求头中包含API密钥:
148158

149159
```
150160
X-API-Key: your_api_key
151161
```
152162

153-
#### 初始化微信
163+
#### 🌟 2.0.0 版本API概览
164+
165+
**总计30+个API接口,涵盖以下功能模块:**
166+
167+
| 功能模块 | API数量 | 主要功能 |
168+
|---------|---------|----------|
169+
| 🔐 认证相关 | 2个 | API密钥验证、权限管理 |
170+
| 📱 微信基础 | 4个 | 初始化、状态检查、重连管理 |
171+
| 💬 消息操作 | 15个 | 发送、接收、监听、文件处理 |
172+
| 👥 好友管理 | 8个 | 添加、删除、申请处理、信息获取 |
173+
| 🏢 群组管理 | 6个 | 创建、管理、成员操作、信息获取 |
174+
| 🌍 朋友圈 | 4个 | 发布、查看、互动操作(Plus版) |
175+
| 🔐 自动登录 | 3个 | 二维码登录、自动登录管理 |
176+
| 🛠️ 辅助功能 | 5个 | 系统监控、队列管理、配置获取 |
154177

178+
#### 📖 快速开始示例
179+
180+
**初始化微信**
155181
```http
156182
POST /api/wechat/initialize
157183
```
158184

159-
#### 发送消息
160-
185+
**发送消息**
161186
```http
162187
POST /api/message/send
163188
Content-Type: application/json
@@ -170,40 +195,60 @@ Content-Type: application/json
170195
}
171196
```
172197

173-
#### 获取新消息
174-
198+
**获取新消息**
175199
```http
176200
GET /api/message/get-next-new?savepic=true&savevideo=true&savefile=true&savevoice=true&parseurl=true
177201
```
178202

179-
#### 添加监听对象
180-
203+
**添加好友(Plus版)**
181204
```http
182-
POST /api/message/listen/add
205+
POST /api/friend/add-new-friend
183206
Content-Type: application/json
184207
185208
{
186-
"who": "群名称或好友名称",
187-
"savepic": true
209+
"keywords": "搜索关键词",
210+
"addmsg": "添加好友消息",
211+
"remark": "备注名称"
188212
}
189213
```
190214

191-
#### 获取监听消息
192-
215+
**群组管理(Plus版)**
193216
```http
194-
GET /api/message/listen/get?who=群名称或好友名称
217+
POST /api/group/manage
218+
Content-Type: application/json
219+
220+
{
221+
"who": "群名称",
222+
"name": "新群名称",
223+
"notice": "群公告内容"
224+
}
195225
```
196226

197-
更多API接口请在图形界面中点击"API说明"按钮查看详细文档。
227+
#### 📋 完整API文档
228+
- **在线文档**:启动服务后访问图形界面,点击"API文档"按钮查看完整文档
229+
- **测试工具**:内置API测试工具,支持在线测试所有接口
230+
- **代码示例**:提供Python、JavaScript等多种语言的调用示例
198231

199232
## 🔄 库的选择
200233

201-
本项目内置两种微信自动化库:
234+
本项目内置两种微信自动化库,均已升级到V2版本:
235+
236+
- **wxauto v39.1.8** 📱:开源的微信自动化库,功能相对基础,**已内置集成**
237+
- **wxautox v39.1.36** 🚀:增强版的微信自动化库,提供更多功能和更高的稳定性,**已内置集成,需要激活码**
238+
239+
### 📊 功能对比表
202240

203-
- **wxauto** 📱:开源的微信自动化库,功能相对基础,**已内置集成**
204-
- **wxautox** 🚀:增强版的微信自动化库,提供更多功能和更高的稳定性,**已内置集成,需要激活码**
241+
| 功能类别 | wxauto | wxautox | 说明 |
242+
|---------|--------|---------|------|
243+
| 基础消息 ||| 文本、图片、文件发送接收 |
244+
| 消息监听 ||| 实时消息获取和监听 |
245+
| 聊天窗口 ||| 窗口操作和管理 |
246+
| 好友管理 ||| 添加、删除、申请处理 |
247+
| 群组管理 ||| 群创建、管理、成员操作 |
248+
| 朋友圈功能 ||| 发布、查看、互动 |
249+
| 自动登录 ||| 二维码登录、自动登录 |
205250

206-
### 选择使用哪个库
251+
### 🔧 选择使用哪个库
207252

208253
您可以通过以下方式选择使用哪个库:
209254

@@ -221,12 +266,14 @@ GET /api/message/listen/get?who=群名称或好友名称
221266
WECHAT_LIB=wxautox
222267
```
223268

224-
### 配置微信自动化库
269+
### ⚙️ 配置微信自动化库
225270

226-
#### wxauto库
271+
#### wxauto v39.1.8(基础版)
227272
- **无需额外配置**:wxauto库已内置,选择后即可直接使用
273+
- **支持功能**:基础消息操作、监听功能、聊天窗口管理
274+
- **适用场景**:简单的消息收发和基础自动化需求
228275

229-
#### wxautox库
276+
#### wxautox v39.1.36(Plus版)
230277

231278
1. **配置激活码**
232279
- **通过图形界面**(推荐):在图形界面中点击"激活wxautox"按钮,输入您的激活码
@@ -236,8 +283,56 @@ GET /api/message/listen/get?who=群名称或好友名称
236283
- 激活码会被安全保存在本地配置文件中
237284
- 每次启动服务时会自动执行激活,无需重复输入
238285

286+
3. **增强功能**
287+
- **好友管理**:添加好友、处理申请、获取好友信息
288+
- **群组管理**:创建群聊、管理群成员、设置群公告
289+
- **朋友圈功能**:发布朋友圈、查看动态、点赞评论
290+
- **自动登录**:二维码登录、自动登录管理
291+
239292
> **注意**:两个库都已内置在程序中,无需额外安装。如果您选择了wxautox但未配置激活码,程序会提示相应的错误信息。
240293
294+
## 🎉 2.0.0 版本更新详情
295+
296+
### 🚀 主要功能更新
297+
298+
#### 1. API接口大幅扩展(30+个接口)
299+
- **消息窗口管理**:15+个API,支持各种消息类型的发送接收
300+
- **好友管理功能**:8个API,完整的好友操作流程
301+
- **群组管理功能**:6个API,全面的群聊管理能力
302+
- **朋友圈管理**:4个API,支持朋友圈发布和互动(Plus版)
303+
- **自动登录相关**:3个API,简化登录流程
304+
- **辅助功能**:5个API,系统监控和配置管理
305+
306+
#### 2. 增强稳定性
307+
- **解决异步任务冲突**:优化任务队列机制,避免并发操作冲突
308+
- **完善错误处理**:统一错误码体系,提供详细的错误信息
309+
- **统一日志系统**:集成统一日志管理,便于问题排查
310+
- **连接状态监控**:实时监控微信连接状态,自动重连机制
311+
312+
#### 3. 集成最新wxauto/x V2版本
313+
- **wxauto v39.1.8**:最新稳定版本,优化基础功能
314+
- **wxautox v39.1.36**:增强版本,新增多项高级功能
315+
- **向后兼容**:保持与旧版本API的兼容性
316+
- **性能优化**:提升消息处理速度和稳定性
317+
318+
#### 4. 集成完整的API文档以及API测试工具
319+
- **内置文档系统**:完整的API文档,支持在线查看
320+
- **交互式测试工具**:支持在线测试所有API接口
321+
- **代码示例**:提供多种编程语言的调用示例
322+
- **实时API状态**:显示API调用统计和状态信息
323+
324+
### 📈 性能提升
325+
- **响应速度**:API响应时间平均提升30%
326+
- **内存优化**:减少内存占用,提高长时间运行稳定性
327+
- **并发处理**:支持更高的并发请求处理能力
328+
- **资源监控**:实时监控系统资源使用情况
329+
330+
### 🔧 开发体验改进
331+
- **更好的错误提示**:详细的错误信息和解决建议
332+
- **完善的日志系统**:分级日志记录,便于调试
333+
- **配置管理优化**:简化配置流程,支持热重载
334+
- **UI界面优化**:更直观的管理界面和操作体验
335+
241336
## ⚙️ 自定义配置
242337

243338
### 通过图形界面配置
@@ -271,21 +366,42 @@ WECHAT_MAX_RETRY=3
271366
```
272367
wxauto_http_api/
273368
├── app/ # 应用程序核心代码
274-
│ ├── api/ # API接口实现
369+
│ ├── api/ # API接口实现(2.0.0 大幅扩展)
370+
│ │ ├── routes.py # 基础API路由
371+
│ │ ├── admin_routes.py # 管理员API
372+
│ │ ├── chat_routes.py # Chat类API(新增)
373+
│ │ ├── group_routes.py # 群组管理API(新增)
374+
│ │ ├── friend_routes.py # 好友管理API(新增)
375+
│ │ ├── wechat_routes.py # 微信扩展API(新增)
376+
│ │ ├── message_operations.py # 消息操作API(新增)
377+
│ │ ├── moments_routes.py # 朋友圈API(新增)
378+
│ │ ├── auxiliary_routes.py # 辅助功能API(新增)
379+
│ │ └── plugin_routes.py # 插件管理API
380+
│ ├── static/ # 静态文件(2.0.0 新增)
381+
│ │ ├── api_docs_sections/ # API文档页面
382+
│ │ ├── css/ # 样式文件
383+
│ │ ├── js/ # JavaScript文件
384+
│ │ └── images/ # 图片资源
385+
│ ├── templates/ # HTML模板(2.0.0 新增)
275386
│ ├── config.py # 配置模块
276-
│ ├── logs.py # 日志模块
387+
│ ├── unified_logger.py # 统一日志系统(2.0.0 重构)
277388
│ ├── plugin_manager.py # 插件管理模块
278389
│ ├── wxautox_activation.py # wxautox激活管理
279390
│ ├── wechat_adapter.py # 微信适配器
391+
│ ├── wechat.py # 微信管理器(2.0.0 增强)
280392
│ ├── api_service.py # API服务实现
281-
│ ├── app_ui.py # UI界面实现
393+
│ ├── app_ui.py # UI界面实现(2.0.0 优化)
282394
│ ├── app_mutex.py # 互斥锁机制
283395
│ ├── ui_service.py # UI服务实现
396+
│ ├── api_queue.py # API队列管理(2.0.0 新增)
397+
│ ├── system_monitor.py # 系统监控(2.0.0 新增)
284398
│ └── run.py # API运行模块
285399
├── build_tools/ # 打包工具
286400
│ ├── build_app.py # 打包脚本
401+
│ ├── build_onefile.py # 单文件打包(2.0.0 新增)
287402
│ ├── build_app.bat # 打包批处理文件
288403
│ ├── create_icon.py # 创建图标脚本
404+
│ ├── version_info.txt # 版本信息(2.0.0 更新)
289405
│ └── *.spec # PyInstaller规范文件
290406
├── data/ # 数据文件
291407
│ ├── api/ # API数据
@@ -294,11 +410,15 @@ wxauto_http_api/
294410
│ │ └── temp/ # 临时文件
295411
│ └── logs/ # 系统日志
296412
├── docs/ # 文档
413+
│ ├── IMG/ # 界面截图(2.0.0 更新)
414+
│ ├── api_documentation.md # API文档(2.0.0 完善)
297415
│ ├── ARCHITECTURE_README.md # 架构说明
298-
│ └── PACKAGING_README.md # 打包说明
416+
│ ├── PACKAGING_README.md # 打包说明
417+
│ └── development_plan.md # 开发计划
418+
├── icons/ # 图标文件(2.0.0 新增)
299419
├── .env # 环境变量配置
300420
├── main.py # 主入口点
301-
├── requirements.txt # 依赖项列表
421+
├── requirements.txt # 依赖项列表(2.0.0 更新)
302422
├── wxautox_activation.json # wxautox激活配置(自动生成)
303423
├── initialize_wechat.bat # 初始化微信批处理文件
304424
├── start_api.bat # 启动API服务的批处理文件
@@ -307,19 +427,84 @@ wxauto_http_api/
307427

308428
## ⚠️ 注意事项
309429

310-
- **微信客户端**:请确保微信PC客户端已登录,建议使用微信3.9版本
430+
### 🔧 系统要求
431+
- **微信客户端**:请确保微信PC客户端已登录,建议使用微信3.9.8及以上版本
432+
- **操作系统**:本项目仅支持Windows操作系统
433+
- **Python版本**:如从源码安装,需要Python 3.7+(推荐3.11+)
311434
- **窗口状态**:使用过程中请勿关闭微信窗口
312-
- **安全性**:API密钥请妥善保管,避免泄露
313-
- **兼容性**:本项目仅支持Windows操作系统
314-
- **依赖项**:使用打包版本无需安装依赖,所有库都已内置;从源码安装时需确保安装所有必要的依赖项
315-
- **微信自动化库**:wxauto和wxautox都已作为核心依赖内置,无需额外安装
435+
436+
### 🔐 安全相关
437+
- **API密钥**:请妥善保管API密钥,避免泄露
316438
- **激活码管理**:wxautox激活码会安全保存在本地,启动时自动激活
439+
- **网络安全**:建议在内网环境使用,避免暴露到公网
440+
441+
### 📦 部署相关
442+
- **打包版本**:使用打包版本无需安装依赖,所有库都已内置
443+
- **源码安装**:从源码安装时需确保安装所有必要的依赖项
444+
- **微信自动化库**:wxauto v39.1.8和wxautox v39.1.36都已作为核心依赖内置
317445
- **打包集成**:所有依赖库都会打包到可执行文件中,确保完整的一体化体验
318446

447+
### 🚀 2.0.0 版本特别说明
448+
- **API兼容性**:2.0.0版本保持与1.x版本的API兼容性
449+
- **功能增强**:Plus版功能需要wxautox激活码支持
450+
- **性能优化**:新版本在稳定性和性能方面有显著提升
451+
- **文档完善**:内置完整的API文档和测试工具,便于开发调试
452+
453+
### 🔍 故障排除
454+
- **连接问题**:如遇微信连接问题,请检查微信客户端状态
455+
- **API调用失败**:查看日志文件获取详细错误信息
456+
- **激活问题**:wxautox激活失败请检查激活码是否正确
457+
- **性能问题**:长时间运行建议定期重启服务
458+
319459
## 📝 许可证
320460

321461
[MIT License](LICENSE)
322462

463+
## 📋 更新日志
464+
465+
### v2.0.0 (2025-01-03) 🎉
466+
**重大版本更新**
467+
468+
#### 🚀 新增功能
469+
- **30+ API接口**:全面覆盖微信自动化各个场景
470+
- 消息窗口管理:15+个API
471+
- 好友管理功能:8个API
472+
- 群组管理功能:6个API
473+
- 朋友圈管理:4个API(Plus版)
474+
- 自动登录相关:3个API
475+
- 辅助功能:5个API
476+
- **集成API文档系统**:内置完整的API文档和在线测试工具
477+
- **wxauto/x V2版本集成**:升级到wxauto v39.1.8 和 wxautox v39.1.36
478+
479+
#### 🔧 稳定性增强
480+
- **解决异步任务冲突**:优化任务队列机制
481+
- **统一日志系统**:重构日志管理,提供更好的调试体验
482+
- **完善错误处理**:统一错误码体系,详细错误信息
483+
- **连接状态监控**:实时监控微信连接状态,自动重连
484+
485+
#### 🎨 界面优化
486+
- **UI界面改进**:更直观的管理界面和操作体验
487+
- **配置管理优化**:简化配置流程,支持热重载
488+
- **实时状态显示**:显示API调用统计和系统状态
489+
490+
#### 📈 性能提升
491+
- **响应速度提升30%**:优化API响应时间
492+
- **内存使用优化**:减少内存占用,提高长时间运行稳定性
493+
- **并发处理能力增强**:支持更高的并发请求
494+
495+
### v1.0.0 (2024-12-01)
496+
**首个正式版本**
497+
- 基础微信自动化API功能
498+
- 图形化管理界面
499+
- wxauto和wxautox库集成
500+
- 基础消息发送接收功能
501+
323502
## 🤝 贡献
324503

325504
欢迎提交问题和功能请求!如果您想贡献代码,请提交拉取请求。
505+
506+
### 贡献指南
507+
- 提交Issue前请先搜索是否已有相关问题
508+
- 提交PR前请确保代码通过测试
509+
- 遵循项目的代码规范和文档格式
510+
- 重大功能变更请先创建Issue讨论

0 commit comments

Comments
 (0)