Files
nullkey c753c67608 docs(api): add and fix swag annotations on handlers
将 swag 注解覆盖率从 ~88% 提升到 100%,并修复审计中发现的若干既有
注解 bug。

新增注解(24 个):
- im.go: 4 (UpdateIMChannel/DeleteIMChannel/ToggleIMChannel/IMCallback)
  其中 IMCallback 同时注册 GET 和 POST,两个方法都加了 @Router 声明。
- web_search.go: 1 (GetProviders)
- web_search_provider.go: 6
- wechat_qrcode.go: 2
- weknoracloud.go: 2
- knowledge.go: 2 (MoveKnowledge/GetKnowledgeMoveProgress)
- knowledgebase.go: 1 (ListMoveTargets)
- organization.go: 3 (ListSharedAgents/ListOrgAgentShares/RemoveAgentShare)
- mcp_service.go: 2 (SetMCPToolApproval/ResolveToolApproval)
- chunker_debug.go: 1 (PreviewChunking)

修复既有注解 bug(12 处):
- initialization.go: 10 个 @Router 路径与真实路由不符
  (e.g. /initialization/kb/{kbId}/config → /initialization/config/{kbId}
   /initialization/fabri/tag GET → /initialization/extract/fabri-tag POST)
- session/stream.go: ContinueStream 路径
  /sessions/{session_id}/continue → /sessions/continue-stream/{session_id}
- mcp_service.go: ResolveToolApproval 请求体 {approve: bool}
  → {decision: "approve"|"reject", reason?, modified_args?}

收敛响应 schema 到已有命名 struct(之前用 map[string]interface{}):
- knowledge.go MoveKnowledge → handler.MoveKnowledgeResponse
- knowledge.go GetKnowledgeMoveProgress → types.KnowledgeMoveProgress
- web_search_provider.go GetProvider/UpdateProvider → types.WebSearchProviderEntity
- initialization.go InitializeByKB → handler.InitializationRequest
- initialization.go 三个 model-test endpoint → handler.ModelTestRequest

修正 organization.go 中 errors.AppError 应使用 apperrors 别名(该文件
stdlib errors 未别名化)。

不补 /files 和 /api/v1/files/presigned 内联闭包路由(文件服务,非业务 REST)。

Refs #890 #1049 #1168
2026-05-12 13:16:58 +08:00

98 lines
3.0 KiB
Go

package handler
import (
"net/http"
"github.com/Tencent/WeKnora/internal/im/wechat"
"github.com/Tencent/WeKnora/internal/logger"
"github.com/gin-gonic/gin"
)
// qrCodeService is a singleton for WeChat QR code operations.
var qrCodeService = wechat.NewQRCodeService()
// WeChatGetQRCode generates a QR code for WeChat login.
// POST /api/v1/wechat/qrcode
//
// WeChatGetQRCode godoc
// @Summary 获取微信扫码登录二维码
// @Description 申请一个用于扫码登录绑定的微信二维码(无请求体)
// @Tags IM 渠道
// @Produce json
// @Success 200 {object} map[string]interface{} "二维码信息(qrcode_url + qrcode 标识)"
// @Failure 500 {object} map[string]interface{} "二维码生成失败"
// @Security Bearer
// @Security ApiKeyAuth
// @Router /wechat/qrcode [post]
func (h *IMHandler) WeChatGetQRCode(c *gin.Context) {
ctx := c.Request.Context()
result, err := qrCodeService.GetLoginQRCode(ctx)
if err != nil {
logger.Errorf(ctx, "[WeChat] Failed to generate QR code: %v", err)
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate QR code: " + err.Error()})
return
}
c.JSON(http.StatusOK, gin.H{
"data": gin.H{
"qrcode_url": result.QRCodeURL,
"qrcode": result.QRCode,
},
})
}
// WeChatPollQRCodeStatus checks the scan status of a WeChat QR code.
// POST /api/v1/wechat/qrcode/status
//
// WeChatPollQRCodeStatus godoc
// @Summary 轮询微信二维码状态
// @Description 查询指定二维码是否已被扫描/确认/过期;confirmed 时返回凭证
// @Tags IM 渠道
// @Accept json
// @Produce json
// @Param request body map[string]interface{} true "{qrcode: string}"
// @Success 200 {object} map[string]interface{} "扫码状态"
// @Failure 400 {object} map[string]interface{} "请求参数错误"
// @Failure 500 {object} map[string]interface{} "服务器错误"
// @Security Bearer
// @Security ApiKeyAuth
// @Router /wechat/qrcode/status [post]
func (h *IMHandler) WeChatPollQRCodeStatus(c *gin.Context) {
ctx := c.Request.Context()
var req struct {
QRCode string `json:"qrcode" binding:"required"`
}
if err := c.ShouldBindJSON(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": "qrcode is required"})
return
}
result, err := qrCodeService.PollQRCodeStatus(ctx, req.QRCode)
if err != nil {
logger.Errorf(ctx, "[WeChat] Failed to poll QR code status: %v", err)
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to check QR code status"})
return
}
resp := gin.H{
"status": result.Status,
}
// Only include credentials when login is confirmed
if result.Status == "confirmed" {
resp["credentials"] = gin.H{
"bot_token": result.BotToken,
"ilink_bot_id": result.ILinkBotID,
"ilink_user_id": result.ILinkUserID,
}
// Include baseurl if the server returned one (may override default)
if result.BaseURL != "" {
resp["baseurl"] = result.BaseURL
}
}
c.JSON(http.StatusOK, gin.H{"data": resp})
}