docs(swagger): restore gold @Router comments on platform APIs

This commit is contained in:
ryan
2026-08-30 14:20:21 +08:00
parent a617457a3c
commit 56c650c5b5
7 changed files with 394 additions and 33 deletions
+12 -3
View File
@@ -56,9 +56,7 @@ func (p *Plugin) Apply(ctx *core.Context) error {
ctx.Router().GET("/api/healthz", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"status": "ok"})
})
ctx.Router().GET("/api/health", func(c *gin.Context) {
c.JSON(http.StatusOK, response.OKNil())
})
ctx.Router().GET("/api/health", Health)
ctx.Router().RegisterWhitelist("/api/health")
// 2. Public config
@@ -92,3 +90,14 @@ func (p *Plugin) Apply(ctx *core.Context) error {
return nil
}
// Health 健康检查
// @Summary 健康检查
// @Description 检查服务是否正常运行,可用于负载均衡存活探测
// @Tags health
// @Produce json
// @Success 200 {object} response.Any{data=string} "服务正常"
// @Router /api/health [get]
func Health(c *gin.Context) {
c.JSON(http.StatusOK, response.OKNil())
}