From ef0478620754e91e556eb377e36e4fddd05d476c Mon Sep 17 00:00:00 2001
From: moyin <244344649@qq.com>
Date: Fri, 9 Jan 2026 17:59:35 +0800
Subject: [PATCH] =?UTF-8?q?docs=EF=BC=9A=E6=B7=BB=E5=8A=A0API=E6=96=87?=
 =?UTF-8?q?=E6=A1=A3=E8=B7=B3=E8=BD=AC=E9=93=BE=E6=8E=A5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- 在WebSocket OpenAPI文档中添加测试页面跳转链接
- 在聊天控制器中添加quickLinks对象
- 支持带参数的跳转，识别来源页面
- 完善API文档的导航体验
---
 src/business/zulip/chat.controller.ts           |  5 +++++
 .../zulip/websocket_openapi.controller.ts       | 17 ++++++++++-------
 2 files changed, 15 insertions(+), 7 deletions(-)

diff --git a/src/business/zulip/chat.controller.ts b/src/business/zulip/chat.controller.ts
index 433b2ba..d83f8f2 100644
--- a/src/business/zulip/chat.controller.ts
+++ b/src/business/zulip/chat.controller.ts
@@ -364,6 +364,11 @@ export class ChatController {
         'chat_render',    // 接收到聊天消息
         'error',          // 通用错误
       ],
+      quickLinks: {
+        testPage: '/websocket-test?from=chat-api',
+        apiDocs: '/api-docs',
+        connectionInfo: '/websocket-api/connection-info'
+      },
       authRequired: true,
       tokenType: 'JWT',
       tokenFormat: {
diff --git a/src/business/zulip/websocket_openapi.controller.ts b/src/business/zulip/websocket_openapi.controller.ts
index bc5a561..3712856 100644
--- a/src/business/zulip/websocket_openapi.controller.ts
+++ b/src/business/zulip/websocket_openapi.controller.ts
@@ -197,6 +197,10 @@ export class WebSocketOpenApiController {
 - ✅ 统一使用 /game 路径
 - ✅ 支持地图房间管理
 - ✅ 实现消息广播机制
+
+**快速测试**: 
+- 🧪 [WebSocket 测试页面](/websocket-test?from=api-docs) - 交互式测试工具
+- 📚 [完整 API 文档](/api-docs) - 返回 Swagger 文档
     `
   })
   @ApiResponse({
@@ -689,13 +693,12 @@ ws.on('error', function(error) {
         `
       },
       testingSteps: [
-        '1. 获取有效的JWT Token（通过 /auth/login 接口）',
-        '2. 使用WebSocket客户端连接到 wss://whaletownend.xinghangee.icu/game',
-        '3. 发送login消息进行认证',
-        '4. 验证收到login_success响应',
-        '5. 发送chat消息测试聊天功能',
-        '6. 发送position消息测试位置更新',
-        '7. 观察其他客户端的消息广播'
+        '1. 访问测试页面: /websocket-test?from=api-docs',
+        '2. 点击"🚀 一键测试"按钮自动完成所有步骤',
+        '3. 或手动操作: 获取JWT Token → 连接 → 登录',
+        '4. 发送chat消息测试聊天功能',
+        '5. 发送position消息测试位置更新',
+        '6. 观察其他客户端的消息广播'
       ],
       troubleshooting: {
         connectionFailed: [