kevin
84768e94ed
- @Tags 由功能维度改为 public/user/admin 权限维度 - main.go 增加全局 tag 声明与权限说明（需放在 @securitydefinitions 之前，否则会被解析器吞掉） - 重新生成 docs/，公开 4 个、需登录 7 个、管理员 11 个接口
105 lines
2.9 KiB
Go
105 lines
2.9 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/config"
|
|
"rill/internal/database"
|
|
"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))
|
|
|
|
authed := rg.Group("", authn.RequireAuth(db))
|
|
{
|
|
authed.GET("/me", auth.Me())
|
|
authed.PUT("/me", auth.UpdateMe(db))
|
|
|
|
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"})
|
|
}
|
|
}
|