admin/TaskPool
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add openapi

Browse Source
This commit is contained in:
engigu
2026-03-05 20:19:35 +08:00
parent a8a24a410c
commit 9fec4ecdb5
15 changed files with 3447 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/controllers/env_controller.go
+77
View File
@@ -17,6 +17,17 @@ func NewEnvController(envService *services.EnvService) *EnvController {
return &EnvController{envService: envService}
}
// CreateEnvVar 创建环境变量
// @Summary 创建环境变量
// @Description 创建新的环境变量
// @Tags 环境变量
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param body body object true "环境变量信息"
// @Success 200 {object} utils.Response{data=vo.EnvVO}
// @Failure 400 {object} utils.Response
// @Router /env [post]
func (ec *EnvController) CreateEnvVar(c *gin.Context) {
userID := c.GetString("userID")
@@ -41,6 +52,18 @@ func (ec *EnvController) CreateEnvVar(c *gin.Context) {
utils.Success(c, vo.ToEnvVO(envVar))
}
// GetEnvVars 获取环境变量列表
// @Summary 获取环境变量列表
// @Description 分页获取环境变量列表，支持按名称筛选
// @Tags 环境变量
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param name query string false "按名称模糊查询"
// @Param page query int false "页码"
// @Param page_size query int false "每页数量"
// @Success 200 {object} utils.Response{data=utils.PaginationData{list=[]vo.EnvVO}}
// @Router /env [get]
func (ec *EnvController) GetEnvVars(c *gin.Context) {
userID := c.GetString("userID")
p := utils.ParsePagination(c)
@@ -49,12 +72,32 @@ func (ec *EnvController) GetEnvVars(c *gin.Context) {
utils.PaginatedResponse(c, vo.ToEnvVOListFromModels(envVars), total, p)
}
// GetAllEnvVars 获取所有环境变量
// @Summary 获取所有环境变量
// @Description 获取当前用户的所有环境变量（不分页）
// @Tags 环境变量
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Success 200 {object} utils.Response{data=[]vo.EnvVO}
// @Router /env/all [get]
func (ec *EnvController) GetAllEnvVars(c *gin.Context) {
userID := c.GetString("userID")
envVars := ec.envService.GetEnvVarsByUserID(userID)
utils.Success(c, vo.ToEnvVOListFromModels(envVars))
}
// GetEnvVar 获取环境变量详情
// @Summary 获取环境变量详情
// @Description 根据 ID 获取环境变量详情
// @Tags 环境变量
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "环境变量ID"
// @Success 200 {object} utils.Response{data=vo.EnvVO}
// @Failure 404 {object} utils.Response
// @Router /env/{id} [get]
func (ec *EnvController) GetEnvVar(c *gin.Context) {
id := c.Param("id")
if id == "" {
@@ -71,6 +114,18 @@ func (ec *EnvController) GetEnvVar(c *gin.Context) {
utils.Success(c, vo.ToEnvVO(envVar))
}
// UpdateEnvVar 更新环境变量
// @Summary 更新环境变量
// @Description 根据 ID 更新环境变量信息
// @Tags 环境变量
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "环境变量ID"
// @Param body body object true "更新信息"
// @Success 200 {object} utils.Response{data=vo.EnvVO}
// @Failure 404 {object} utils.Response
// @Router /env/{id} [put]
func (ec *EnvController) UpdateEnvVar(c *gin.Context) {
id := c.Param("id")
if id == "" {
@@ -110,6 +165,18 @@ func (ec *EnvController) UpdateEnvVar(c *gin.Context) {
utils.Success(c, vo.ToEnvVO(envVar))
}
// DeleteEnvVar 删除环境变量
// @Summary 删除环境变量
// @Description 根据 ID 删除环境变量，支持强制删除
// @Tags 环境变量
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "环境变量ID"
// @Param force query bool false "是否强制删除"
// @Success 200 {object} utils.Response
// @Failure 409 {object} utils.Response{data=[]vo.TaskVO} "引用冲突"
// @Router /env/{id} [delete]
func (ec *EnvController) DeleteEnvVar(c *gin.Context) {
id := c.Param("id")
if id == "" {
@@ -137,6 +204,16 @@ func (ec *EnvController) DeleteEnvVar(c *gin.Context) {
utils.SuccessMsg(c, "删除成功")
}
// GetAssociatedTasks 获取关联任务
// @Summary 获取关联任务
// @Description 获取引用了该环境变量的任务列表
// @Tags 环境变量
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "环境变量ID"
// @Success 200 {object} utils.Response{data=[]vo.TaskVO}
// @Router /env/{id}/tasks [get]
func (ec *EnvController) GetAssociatedTasks(c *gin.Context) {
id := c.Param("id")
if id == "" {
internal/controllers/log_controller.go
+47
View File
@@ -16,6 +16,20 @@ func NewLogController() *LogController {
return &LogController{}
}
// GetLogs 获取任务日志列表
// @Summary 获取任务日志列表
// @Description 分页获取任务日志列表，支持按任务 ID、任务名称、状态筛选
// @Tags 日志
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param task_id query string false "任务 ID"
// @Param task_name query string false "任务名称"
// @Param status query string false "状态"
// @Param page query int false "页码"
// @Param page_size query int false "每页数量"
// @Success 200 {object} utils.Response{data=utils.PaginationData{list=[]vo.TaskLogVO}}
// @Router /logs [get]
func (lc *LogController) GetLogs(c *gin.Context) {
p := utils.ParsePagination(c)
taskID := c.DefaultQuery("task_id", "")
@@ -85,6 +99,17 @@ func (lc *LogController) GetLogs(c *gin.Context) {
utils.PaginatedResponse(c, result, total, p)
}
// GetLogDetail 获取日志详情
// @Summary 获取日志详情
// @Description 根据 ID 获取任务日志详细内容（包含输出）
// @Tags 日志
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "日志ID"
// @Success 200 {object} utils.Response{data=vo.TaskLogVO}
// @Failure 404 {object} utils.Response
// @Router /logs/{id} [get]
func (lc *LogController) GetLogDetail(c *gin.Context) {
id := c.Param("id")
if id == "" {
@@ -101,6 +126,17 @@ func (lc *LogController) GetLogDetail(c *gin.Context) {
utils.Success(c, vo.ToTaskLogVO(&log))
}
// ClearLogs 清空日志
// @Summary 清空日志
// @Description 清空所有日志或指定任务的日志
// @Tags 日志
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param body body object false "清空范围信息"
// @Success 200 {object} utils.Response
// @Failure 500 {object} utils.Response
// @Router /logs/clear [post]
func (lc *LogController) ClearLogs(c *gin.Context) {
var req struct {
TaskID *string `json:"task_id"`
@@ -126,6 +162,17 @@ func (lc *LogController) ClearLogs(c *gin.Context) {
utils.SuccessMsg(c, "日志清空成功")
}
// DeleteLog 删除日志
// @Summary 删除日志
// @Description 根据 ID 删除单条任务日志
// @Tags 日志
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "日志ID"
// @Success 200 {object} utils.Response
// @Failure 500 {object} utils.Response
// @Router /logs/{id} [delete]
func (lc *LogController) DeleteLog(c *gin.Context) {
id := c.Param("id")
if id == "" {
internal/controllers/task_controller.go
+60
View File
@@ -105,6 +105,21 @@ func (tc *TaskController) CreateTask(c *gin.Context) {
utils.Success(c, vo.ToTaskVO(task))
}
// GetTasks 获取任务列表
// @Summary 获取任务列表
// @Description 分页获取任务列表，支持按名称、Agent ID、标签、类型筛选
// @Tags 任务
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param name query string false "任务名称"
// @Param agent_id query string false "Agent ID"
// @Param tags query string false "标签"
// @Param type query string false "任务类型"
// @Param page query int false "页码"
// @Param page_size query int false "每页数量"
// @Success 200 {object} utils.Response{data=utils.PaginationData{list=[]vo.TaskVO}}
// @Router /tasks [get]
func (tc *TaskController) GetTasks(c *gin.Context) {
p := utils.ParsePagination(c)
name := c.DefaultQuery("name", "")
@@ -122,6 +137,17 @@ func (tc *TaskController) GetTasks(c *gin.Context) {
utils.PaginatedResponse(c, vo.ToTaskVOListFromModels(tasks), total, p)
}
// GetTask 获取任务详情
// @Summary 获取任务详情
// @Description 根据 ID 获取任务详情
// @Tags 任务
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "任务ID"
// @Success 200 {object} utils.Response{data=vo.TaskVO}
// @Failure 404 {object} utils.Response
// @Router /tasks/{id} [get]
func (tc *TaskController) GetTask(c *gin.Context) {
id := c.Param("id")
if id == "" {
@@ -138,6 +164,18 @@ func (tc *TaskController) GetTask(c *gin.Context) {
utils.Success(c, vo.ToTaskVO(task))
}
// UpdateTask 更新任务
// @Summary 更新任务
// @Description 根据 ID 更新任务信息
// @Tags 任务
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "任务ID"
// @Param body body object true "任务更新信息"
// @Success 200 {object} utils.Response{data=vo.TaskVO}
// @Failure 404 {object} utils.Response
// @Router /tasks/{id} [put]
func (tc *TaskController) UpdateTask(c *gin.Context) {
id := c.Param("id")
if id == "" {
@@ -221,6 +259,17 @@ func (tc *TaskController) UpdateTask(c *gin.Context) {
utils.Success(c, vo.ToTaskVO(task))
}
// DeleteTask 删除任务
// @Summary 删除任务
// @Description 根据 ID 删除任务
// @Tags 任务
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param id path string true "任务ID"
// @Success 200 {object} utils.Response
// @Failure 404 {object} utils.Response
// @Router /tasks/{id} [delete]
func (tc *TaskController) DeleteTask(c *gin.Context) {
id := c.Param("id")
if id == "" {
@@ -251,6 +300,17 @@ func (tc *TaskController) DeleteTask(c *gin.Context) {
utils.SuccessMsg(c, "删除成功")
}
// StopTask 停止任务
// @Summary 停止任务
// @Description 根据运行日志 ID 停止正在执行的任务
// @Tags 任务
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Param logID path string true "运行日志ID"
// @Success 200 {object} utils.Response
// @Failure 400 {object} utils.Response
// @Router /tasks/stop/{logID} [post]
func (tc *TaskController) StopTask(c *gin.Context) {
logID := c.Param("logID")
if logID == "" {
internal/middleware/auth.go
+23
View File
@@ -2,6 +2,7 @@ package middleware
import (
"encoding/json"
"net/http"
"time"
"github.com/engigu/baihu-panel/internal/constant"
@@ -115,3 +116,25 @@ func SetAuthCookie(c *gin.Context, token string, expireDays int) {
func ClearAuthCookie(c *gin.Context) {
c.SetCookie(constant.CookieName, "", -1, "/", "", false, true)
}
// SwaggerAuth Swagger 认证中间件 (Basic Auth)
func SwaggerAuth() gin.HandlerFunc {
return func(c *gin.Context) {
cfg := services.GetConfig()
if !cfg.Swagger.Enabled {
c.Status(404)
c.Abort()
return
}
user, password, hasAuth := c.Request.BasicAuth()
if hasAuth && user == cfg.Swagger.User && password == cfg.Swagger.Password {
c.Next()
return
}
c.Header("WWW-Authenticate", `Basic realm="restricted"`)
c.Status(http.StatusUnauthorized)
c.Abort()
}
}
internal/router/router.go
+5
View File
@@ -11,6 +11,8 @@ import (
"github.com/engigu/baihu-panel/internal/static"
"github.com/gin-gonic/gin"
swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
)
type Controllers struct {
@@ -83,6 +85,9 @@ func Setup(c *Controllers) *gin.Engine {
})
}
// Swagger documentation (带 Basic Auth 认证)
root.GET("/swagger/*any", middleware.SwaggerAuth(), ginSwagger.WrapHandler(swaggerFiles.Handler))
// API 路由组
api := root.Group("/api/v1")
{
internal/services/config_service.go
+22
View File
@@ -31,10 +31,17 @@ type SecurityConfig struct {
Secret string `ini:"secret"`
}
type SwaggerConfig struct {
Enabled bool `ini:"enabled"`
User string `ini:"user"`
Password string `ini:"password"`
}
type AppConfig struct {
Server ServerConfig `ini:"server"`
Database DatabaseConfig `ini:"database"`
Security SecurityConfig `ini:"security"`
Swagger SwaggerConfig `ini:"swagger"`
}
var Config *AppConfig
@@ -75,6 +82,11 @@ func LoadConfig(path string) (*AppConfig, error) {
Security: SecurityConfig{
Secret: "",
},
Swagger: SwaggerConfig{
Enabled: false,
User: "admin",
Password: "swagger_password",
},
}
// 检查配置文件是否存在
@@ -141,6 +153,16 @@ func applyEnvOverrides() {
// Security
getEnvStr("BH_SECRET", &Config.Security.Secret)
// Swagger
vSwaggerEnabled := os.Getenv("BH_SWAGGER_ENABLED")
if vSwaggerEnabled == "true" || vSwaggerEnabled == "1" {
Config.Swagger.Enabled = true
} else if vSwaggerEnabled == "false" || vSwaggerEnabled == "0" {
Config.Swagger.Enabled = false
}
getEnvStr("BH_SWAGGER_USER", &Config.Swagger.User)
getEnvStr("BH_SWAGGER_PASSWORD", &Config.Swagger.Password)
}
func GetConfig() *AppConfig {
internal/utils/pagination.go
+13 -5
View File
@@ -51,12 +51,20 @@ func (p Pagination) Offset() int {
return (p.Page - 1) * p.PageSize
}
// PaginationData 分页数据
type PaginationData struct {
List interface{} `json:"list"`
Total int64 `json:"total"`
Page int `json:"page"`
PageSize int `json:"page_size"`
}
// PaginatedResponse 分页响应
func PaginatedResponse(c *gin.Context, data interface{}, total int64, p Pagination) {
Success(c, gin.H{
"data": data,
"total": total,
"page": p.Page,
"page_size": p.PageSize,
Success(c, PaginationData{
List: data,
Total: total,
Page: p.Page,
PageSize: p.PageSize,
})
}