Skip to content

Commit ba8b9ca

Browse files
committed
docs: 更新README.md,添加Swagger UI接口文档访问说明
1 parent 0040969 commit ba8b9ca

File tree

3 files changed

+9
-51
lines changed

3 files changed

+9
-51
lines changed

README.md

Lines changed: 9 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@
9898
- `wechat/get_dialogs_by_time_blocks`:根据时间段获取聊天记录,返回嵌套列表
9999
- `wechat/send_file`:发送文件
100100

101+
```
102+
.....更多接口请部署服务的后访问交互式文档 `http://127.0.0.1:8000/api/schema/swagger-ui/`
103+
```
101104
### 并发保证
102105

103106
服务端有消息队列和互斥锁,只需要把消息发送给服务端,服务端会自动处理消息队列,保证消息依次发送,所以你还可以部署多个客户端对同一个服务端发送消息
@@ -150,62 +153,17 @@ Windows资源管理器复制出来文件路径是:`C:\Program Files\Tencent\We
150153

151154
## 测试服务端是否正常运行
152155

153-
上一步安装并运行服务端后,可以用简单的命令测试服务端是否成功运行
154-
155-
### 在Windows上:
156-
打开终端(powershell):
156+
上一步安装并运行服务端后,可以访问`http://127.0.0.1:8000/api/schema/swagger-ui/`
157+
![img.png](img/img29.png)
158+
可以看到服务端的接口文档,并且进行接口测试
157159

158-
#### 测试服务端是否正常运行
159-
160-
```shell
161-
curl http://127.0.0.1:8000/wechat/ping
162-
```
160+
另外还有其他类型的接口文档可选:
161+
`http://127.0.0.1:8000/api/schema/redoc/`
162+
![img.png](img/img_30.png)
163163

164-
正常会返回
165164

166-
```shell
167-
StatusCode : 200
168-
StatusDescription : OK
169-
Content : {"status": "pong"}
170-
RawContent : HTTP/1.1 200 OK
171-
Vary: origin
172-
X-Frame-Options: DENY
173-
X-Content-Type-Options: nosniff
174-
Referrer-Policy: same-origin
175-
Cross-Origin-Opener-Policy: same-origin
176-
Content-Length: 18
177-
Content-Type: applicat...
178-
Forms : {}
179-
Headers : {[Vary, origin], [X-Frame-Options, DENY], [X-Content-Type-Options, nosniff], [Referrer-Policy, same
180-
-origin]...}
181-
Images : {}
182-
InputFields : {}
183-
Links : {}
184-
Links : {} ParsedHtml : System.__ComObject RawContentLength : 18
185-
```
186165

187-
#### 发送消息
188166

189-
```shell
190-
$jsonData = '{"name": "文件传输助手", "text": "hi"}'
191-
Invoke-WebRequest -Uri http://127.0.0.1:8000/wechat/send_message/ -Method Post -Headers @{"Content-Type"="application/json"} -Body $jsonData -ContentType "application/json; charset=utf-8"
192-
```
193-
这个命令会给文件传输助手发送一条消息`hi`
194-
195-
### 在linux/mac上:
196-
打开终端:
197-
198-
#### 测试服务端是否正常运行
199-
200-
```shell
201-
curl -X GET http://替换成服务器的ip地址:8000/wechat/ping/
202-
```
203-
204-
#### 发送消息
205-
206-
```shell
207-
curl -X POST http://替换成服务器的ip地址:8000/wechat/send_message/ -H "Content-Type: application/json" -d '{"name": "文件传输助手", "text": "hi"}'
208-
```
209167
## 确保Windows不锁屏
210168
YuYuWechatV2_Server需要GUI界面,所以需要保证Windows不会锁屏
211169
- 首先在电源选项里设置不永不关闭屏幕

img/img29.png

191 KB
Loading

img/img_30.png

242 KB
Loading

0 commit comments

Comments
 (0)