Files
rill/internal/api/api.go
T
kevin 9bf397064d 新增文件上传接口与用户头像裁剪上传
- 新增 storage 配置(存储目录、单文件大小上限),ConfigVersion 3→4 自动补全
- internal/file:上传(sha256 秒传去重)、删除(上传者或管理员,引用中 409)、公开查看;本地存储 + 操作日志 + 引用计数,仅安全类型内联防存储型 XSS
- internal/avatar:PUT/DELETE /api/me/avatar,自动管理头像文件引用与旧头像解绑
- 前端引入 vue-advanced-cropper,个人中心支持上传/更换/删除头像,裁剪输出 512×512 JPEG;http 请求支持 FormData
- 导出 auth.CurrentUser、新增 model.User.IsAdmin 与 testutil 多部件上传辅助,补充接口测试并重新生成 Swagger 文档
2026-09-21 20:50:19 +08:00

112 lines
3.2 KiB
Go

// Package api 负责 HTTP 接口路由装配。
package api
import (
"net/http"
"path"
"github.com/gin-gonic/gin"
swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
"gorm.io/gorm"
"rill/internal/auth"
"rill/internal/avatar"
"rill/internal/config"
"rill/internal/database"
"rill/internal/file"
"rill/internal/note"
"rill/internal/site"
"rill/internal/user"
"rill/internal/usergroup"
)
// RegisterRoutes 注册 API 路由。health、swagger、auth、站点信息与文件查看公开;notes、个人资料与文件上传删除需登录;站点信息更新、用户与用户组管理仅限管理员。
func RegisterRoutes(rg *gin.RouterGroup, db *gorm.DB, cfg *config.Config) {
authn := auth.NewAuthenticator(cfg)
rg.GET("/health", health(db))
swagger := rg.Group("/swagger")
{
swagger.GET("", func(c *gin.Context) {
c.Redirect(http.StatusFound, path.Join("/", rg.BasePath(), "swagger", "index.html"))
})
swagger.GET("/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, ginSwagger.URL("doc.json")))
}
authGroup := rg.Group("/auth")
{
authGroup.POST("/register", auth.Register(db))
authGroup.POST("/login", auth.Login(db, authn))
}
rg.GET("/site", site.Get(db))
rg.GET("/files/:id", file.View(db, cfg))
authed := rg.Group("", authn.RequireAuth(db))
{
authed.GET("/me", auth.Me())
authed.PUT("/me", auth.UpdateMe(db))
authed.PUT("/me/avatar", avatar.Update(db, cfg))
authed.DELETE("/me/avatar", avatar.Delete(db, cfg))
authed.POST("/files", file.Upload(db, cfg))
authed.DELETE("/files/:id", file.Delete(db, cfg))
notes := authed.Group("/notes")
{
notes.GET("", note.List(db))
notes.POST("", note.Create(db))
notes.GET("/:id", note.Get(db))
notes.PUT("/:id", note.Update(db))
notes.DELETE("/:id", note.Delete(db))
}
}
admin := rg.Group("", authn.RequireAuth(db), auth.RequireAdmin())
{
admin.PUT("/site", site.Update(db))
users := admin.Group("/users")
{
users.GET("", user.List(db))
users.POST("", user.Create(db))
users.GET("/:id", user.Get(db))
users.PUT("/:id", user.Update(db))
users.DELETE("/:id", user.Delete(db))
}
groups := admin.Group("/user-groups")
{
groups.GET("", usergroup.List(db))
groups.POST("", usergroup.Create(db))
groups.GET("/:id", usergroup.Get(db))
groups.PUT("/:id", usergroup.Update(db))
groups.DELETE("/:id", usergroup.Delete(db))
}
}
}
// HealthResponse 健康检查响应。
type HealthResponse struct {
Status string `json:"status" example:"ok"`
Error string `json:"error,omitempty" example:"database unavailable"`
}
// @Summary Health check
// @Description Check service and database connectivity; returns 503 when the database is unavailable.
// @Tags public
// @Produce json
// @Success 200 {object} api.HealthResponse
// @Failure 503 {object} api.HealthResponse
// @Router /health [get]
func health(db *gorm.DB) gin.HandlerFunc {
return func(c *gin.Context) {
if err := database.Ping(c.Request.Context(), db); err != nil {
c.JSON(http.StatusServiceUnavailable, HealthResponse{Status: "error", Error: "database unavailable"})
return
}
c.JSON(http.StatusOK, HealthResponse{Status: "ok"})
}
}