Skip to content

feat: 添加健康检查 API 及相关文档 #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hanxuanyu merged 1 commit into from
Apr 20, 2026
Merged

feat: 添加健康检查 API 及相关文档 #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,6 +1069,49 @@ const docTemplate = `{
}
}
}
},
"/api/health": {
"get": {
"security": [
{
"APITokenAuth": []
}
],
"description": "检查服务运行状态，需要有效的 API Token 或管理员 JWT 进行鉴权。",
"produces": [
"application/json"
],
"tags": [
"Public"
],
"summary": "健康检查",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/model.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/public.HealthResponse"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/model.Response"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -1584,6 +1627,27 @@ const docTemplate = `{
}
}
},
"public.HealthResponse": {
"type": "object",
"properties": {
"database": {
"type": "string",
"example": "ok"
},
"go_version": {
"type": "string",
"example": "go1.21.0"
},
"status": {
"type": "string",
"example": "ok"
},
"uptime": {
"type": "string",
"example": "2h30m15s"
}
}
},
"public.PickupResponse": {
"type": "object",
"properties": {
Expand Down
64 changes: 64 additions & 0 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1062,6 +1062,49 @@
}
}
}
},
"/api/health": {
"get": {
"security": [
{
"APITokenAuth": []
}
],
"description": "检查服务运行状态，需要有效的 API Token 或管理员 JWT 进行鉴权。",
"produces": [
"application/json"
],
"tags": [
"Public"
],
"summary": "健康检查",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/model.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/public.HealthResponse"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/model.Response"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -1577,6 +1620,27 @@
}
}
},
"public.HealthResponse": {
"type": "object",
"properties": {
"database": {
"type": "string",
"example": "ok"
},
"go_version": {
"type": "string",
"example": "go1.21.0"
},
"status": {
"type": "string",
"example": "ok"
},
"uptime": {
"type": "string",
"example": "2h30m15s"
}
}
},
"public.PickupResponse": {
"type": "object",
"properties": {
Expand Down
39 changes: 39 additions & 0 deletions docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,21 @@ definitions:
max_downloads:
type: integer
type: object
public.HealthResponse:
properties:
database:
example: ok
type: string
go_version:
example: go1.21.0
type: string
status:
example: ok
type: string
uptime:
example: 2h30m15s
type: string
type: object
public.PickupResponse:
properties:
content:
Expand Down Expand Up @@ -1060,6 +1075,30 @@ paths:
summary: 下载单个文件
tags:
- Public
/api/health:
get:
description: 检查服务运行状态，需要有效的 API Token 或管理员 JWT 进行鉴权。
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/model.Response'
- properties:
data:
$ref: '#/definitions/public.HealthResponse'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/model.Response'
security:
- APITokenAuth: []
summary: 健康检查
tags:
- Public
securityDefinitions:
APITokenAuth:
description: Type "Bearer <API-Token>" to authenticate. Required scope depends
Expand Down
55 changes: 55 additions & 0 deletions internal/api/public/health.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package public

import (
"FileRelay/internal/bootstrap"
"FileRelay/internal/model"
"net/http"
"runtime"
"time"

"github.com/gin-gonic/gin"
)

var startTime = time.Now()

type HealthHandler struct{}

func NewHealthHandler() *HealthHandler {
return &HealthHandler{}
}

type HealthResponse struct {
Status string `json:"status" example:"ok"`
Uptime string `json:"uptime" example:"2h30m15s"`
Database string `json:"database" example:"ok"`
GoVer string `json:"go_version" example:"go1.21.0"`
}

// Health 健康检查
// @Summary 健康检查
// @Description 检查服务运行状态，需要有效的 API Token 或管理员 JWT 进行鉴权。
// @Tags Public
// @Produce json
// @Security APITokenAuth
// @Success 200 {object} model.Response{data=HealthResponse}
// @Failure 401 {object} model.Response
// @Router /api/health [get]
func (h *HealthHandler) Health(c *gin.Context) {
dbStatus := "ok"
sqlDB, err := bootstrap.DB.DB()
if err != nil || sqlDB.Ping() != nil {
dbStatus = "unavailable"
}

status := "ok"
if dbStatus != "ok" {
status = "degraded"
}

c.JSON(http.StatusOK, model.SuccessResponse(HealthResponse{
Status: status,
Uptime: time.Since(startTime).Round(time.Second).String(),
Database: dbStatus,
GoVer: runtime.Version(),
}))
}
3 changes: 3 additions & 0 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,12 @@ func main() {
pickupHandler := public.NewPickupHandler()
publicConfigHandler := public.NewConfigHandler()

healthHandler := public.NewHealthHandler()

api := r.Group("/api")
{
api.GET("/config", publicConfigHandler.GetPublicConfig)
api.GET("/health", middleware.APITokenAuth("", false), healthHandler.Health)
// 统一使用 /batches 作为资源路径
api.POST("/batches", middleware.UploadAuth(), uploadHandler.Upload)
api.POST("/batches/text", middleware.UploadAuth(), uploadHandler.UploadText)
Expand Down
Loading