docs:添加API文档跳转链接
- 在WebSocket OpenAPI文档中添加测试页面跳转链接 - 在聊天控制器中添加quickLinks对象 - 支持带参数的跳转,识别来源页面 - 完善API文档的导航体验
This commit is contained in:
@@ -364,6 +364,11 @@ export class ChatController {
|
|||||||
'chat_render', // 接收到聊天消息
|
'chat_render', // 接收到聊天消息
|
||||||
'error', // 通用错误
|
'error', // 通用错误
|
||||||
],
|
],
|
||||||
|
quickLinks: {
|
||||||
|
testPage: '/websocket-test?from=chat-api',
|
||||||
|
apiDocs: '/api-docs',
|
||||||
|
connectionInfo: '/websocket-api/connection-info'
|
||||||
|
},
|
||||||
authRequired: true,
|
authRequired: true,
|
||||||
tokenType: 'JWT',
|
tokenType: 'JWT',
|
||||||
tokenFormat: {
|
tokenFormat: {
|
||||||
|
|||||||
@@ -197,6 +197,10 @@ export class WebSocketOpenApiController {
|
|||||||
- ✅ 统一使用 /game 路径
|
- ✅ 统一使用 /game 路径
|
||||||
- ✅ 支持地图房间管理
|
- ✅ 支持地图房间管理
|
||||||
- ✅ 实现消息广播机制
|
- ✅ 实现消息广播机制
|
||||||
|
|
||||||
|
**快速测试**:
|
||||||
|
- 🧪 [WebSocket 测试页面](/websocket-test?from=api-docs) - 交互式测试工具
|
||||||
|
- 📚 [完整 API 文档](/api-docs) - 返回 Swagger 文档
|
||||||
`
|
`
|
||||||
})
|
})
|
||||||
@ApiResponse({
|
@ApiResponse({
|
||||||
@@ -689,13 +693,12 @@ ws.on('error', function(error) {
|
|||||||
`
|
`
|
||||||
},
|
},
|
||||||
testingSteps: [
|
testingSteps: [
|
||||||
'1. 获取有效的JWT Token(通过 /auth/login 接口)',
|
'1. 访问测试页面: /websocket-test?from=api-docs',
|
||||||
'2. 使用WebSocket客户端连接到 wss://whaletownend.xinghangee.icu/game',
|
'2. 点击"🚀 一键测试"按钮自动完成所有步骤',
|
||||||
'3. 发送login消息进行认证',
|
'3. 或手动操作: 获取JWT Token → 连接 → 登录',
|
||||||
'4. 验证收到login_success响应',
|
'4. 发送chat消息测试聊天功能',
|
||||||
'5. 发送chat消息测试聊天功能',
|
'5. 发送position消息测试位置更新',
|
||||||
'6. 发送position消息测试位置更新',
|
'6. 观察其他客户端的消息广播'
|
||||||
'7. 观察其他客户端的消息广播'
|
|
||||||
],
|
],
|
||||||
troubleshooting: {
|
troubleshooting: {
|
||||||
connectionFailed: [
|
connectionFailed: [
|
||||||
|
|||||||
Reference in New Issue
Block a user