Documentation
¶
Index ¶
- func BindResourceInput(db *gorm.DB, c *gin.Context, value any, fields []string) []string
- func CreateResource[T any](db *gorm.DB, row *T, fields, submitted []string) error
- func RegisterResource[T any](a *admin.App, g *route.Registrar, r Resource[T])
- func RegisterResourceFiles[T any](a *admin.App, g *route.Registrar, r Resource[T], ...) gin.HandlerFunc
- func RegisterResourceRoutes(a *admin.App, g *route.Registrar, path, permission string, h ResourceHandlers)
- type Controller
- func (a *Controller) AttachmentRoutes(g *route.Registrar)
- func (a *Controller) AuthRoutes(g *route.Registrar)
- func (a *Controller) CacheRoutes(g *route.Registrar)
- func (a *Controller) ChatRoutes(g *route.Registrar)
- func (a *Controller) CheckUpload(c *gin.Context, input UploadInput) (models.Attachment, bool, error)
- func (a *Controller) DashboardRoutes(g *route.Registrar)
- func (a *Controller) DatabaseRoutes(g *route.Registrar)
- func (a *Controller) GeneratorRoutes(g *route.Registrar)
- func (a *Controller) HorizonRoutes(g *route.Registrar)
- func (a *Controller) KnowledgeRoutes(g *route.Registrar)
- func (a *Controller) LinkRoutes(g *route.Registrar)
- func (a *Controller) LogRoutes(g *route.Registrar)
- func (a *Controller) MailRoutes(g *route.Registrar)
- func (a *Controller) MemberRoutes(g *route.Registrar)
- func (a *Controller) RealtimeRoutes(g *route.Registrar)
- func (a *Controller) RoleRoutes(g *route.Registrar)
- func (a *Controller) SaveUpload(c *gin.Context, reader io.Reader, input UploadInput, limit int64) (models.Attachment, error)
- func (a *Controller) ServeAttachment(c *gin.Context, row models.Attachment)
- func (a *Controller) ServerRoutes(g *route.Registrar)
- func (a *Controller) SettingRoutes(g *route.Registrar)
- func (a *Controller) SkillRoutes(g *route.Registrar)
- func (a *Controller) SupportPublicRoutes()
- func (a *Controller) SupportRoutes(g *route.Registrar)
- func (a *Controller) UserRoutes(g *route.Registrar)
- type Resource
- type ResourceHandlers
- type UploadInput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BindResourceInput ¶ added in v0.1.1
BindResourceInput 将实际提交的可写字段绑定到新记录或已读取的记录。 返回实际提交的数据库字段名;PATCH保留缺省字段,PUT重置全部可写字段。
func CreateResource ¶ added in v0.1.1
CreateResource 使用原生map写入保留显式零值,让未提交的字段使用数据库默认值。
func RegisterResource ¶
func RegisterResourceFiles ¶ added in v0.1.1
func RegisterResourceFiles[T any](a *admin.App, g *route.Registrar, r Resource[T], query func(*gin.Context) *gorm.DB) gin.HandlerFunc
RegisterResourceFiles 注册导入与模板,并返回集合的CSV表示处理函数。
func RegisterResourceRoutes ¶ added in v0.1.3
func RegisterResourceRoutes(a *admin.App, g *route.Registrar, path, permission string, h ResourceHandlers)
RegisterResourceRoutes 统一资源方法、id参数、操作权限和路由名称,业务处理仍由调用方提供。
Types ¶
type Controller ¶
Controller 持有后台模块共享的连接和定义。
func (*Controller) AttachmentRoutes ¶
func (a *Controller) AttachmentRoutes(g *route.Registrar)
func (*Controller) AuthRoutes ¶
func (a *Controller) AuthRoutes(g *route.Registrar)
func (*Controller) CacheRoutes ¶
func (a *Controller) CacheRoutes(g *route.Registrar)
func (*Controller) ChatRoutes ¶ added in v0.1.1
func (a *Controller) ChatRoutes(g *route.Registrar)
func (*Controller) CheckUpload ¶ added in v0.1.3
func (a *Controller) CheckUpload(c *gin.Context, input UploadInput) (models.Attachment, bool, error)
CheckUpload reuses an existing file by both digests and records the caller's ownership. Callers authenticate the user and set Scope/OwnerID before using this method.
func (*Controller) DashboardRoutes ¶
func (a *Controller) DashboardRoutes(g *route.Registrar)
func (*Controller) DatabaseRoutes ¶
func (a *Controller) DatabaseRoutes(g *route.Registrar)
func (*Controller) GeneratorRoutes ¶
func (a *Controller) GeneratorRoutes(g *route.Registrar)
func (*Controller) HorizonRoutes ¶
func (a *Controller) HorizonRoutes(g *route.Registrar)
func (*Controller) KnowledgeRoutes ¶ added in v0.1.3
func (a *Controller) KnowledgeRoutes(g *route.Registrar)
func (*Controller) LinkRoutes ¶
func (a *Controller) LinkRoutes(g *route.Registrar)
func (*Controller) LogRoutes ¶
func (a *Controller) LogRoutes(g *route.Registrar)
func (*Controller) MailRoutes ¶
func (a *Controller) MailRoutes(g *route.Registrar)
func (*Controller) MemberRoutes ¶ added in v0.1.3
func (a *Controller) MemberRoutes(g *route.Registrar)
func (*Controller) RealtimeRoutes ¶
func (a *Controller) RealtimeRoutes(g *route.Registrar)
func (*Controller) RoleRoutes ¶
func (a *Controller) RoleRoutes(g *route.Registrar)
func (*Controller) SaveUpload ¶ added in v0.1.3
func (a *Controller) SaveUpload(c *gin.Context, reader io.Reader, input UploadInput, limit int64) (models.Attachment, error)
SaveUpload 校验实际内容后,通过统一配置的存储写入文件并登记附件归属。
func (*Controller) ServeAttachment ¶ added in v0.1.3
func (a *Controller) ServeAttachment(c *gin.Context, row models.Attachment)
func (*Controller) ServerRoutes ¶
func (a *Controller) ServerRoutes(g *route.Registrar)
func (*Controller) SettingRoutes ¶
func (a *Controller) SettingRoutes(g *route.Registrar)
func (*Controller) SkillRoutes ¶ added in v0.1.3
func (a *Controller) SkillRoutes(g *route.Registrar)
func (*Controller) SupportPublicRoutes ¶ added in v0.1.3
func (a *Controller) SupportPublicRoutes()
func (*Controller) SupportRoutes ¶ added in v0.1.3
func (a *Controller) SupportRoutes(g *route.Registrar)
func (*Controller) UserRoutes ¶
func (a *Controller) UserRoutes(g *route.Registrar)
type Resource ¶
type Resource[T any] struct { Path, Permission string Name string // 可选的独立路由名称前缀 Fields, Search, Required []string Tree, Importable bool Scope func(*gorm.DB, *admin.Actor) *gorm.DB WriteScope func(*gorm.DB, *admin.Actor) *gorm.DB // 目录可读,写入另受管理级别限制 AfterWrite func(context.Context) error // 仅在写入成功、事务提交后执行 Validate func(*T, *admin.Actor, bool) error Prepare func(*T, *admin.Actor, bool) }
Resource 只描述重复的CRUD,业务约束由所属模块提供。
type ResourceHandlers ¶ added in v0.1.3
type ResourceHandlers struct {
Name string // 共用权限前缀的不同资源可指定各自的路由名称前缀
Index, Store, Show, Update, Destroy gin.HandlerFunc
}
ResourceHandlers 提供标准资源操作;未提供的操作不注册,Destroy同时处理单条与批量删除。
type UploadInput ¶ added in v0.1.3
type UploadInput struct {
Scope string `json:"-"`
OwnerID uint `json:"-"`
Name string `json:"name" binding:"required,max=255"`
MD5 string `json:"md5" binding:"required,len=32,hexadecimal"`
SHA256 string `json:"sha256" binding:"required,len=64,hexadecimal"`
Size int64 `json:"size" binding:"required,gt=0"`
CategoryID uint `json:"category_id"`
}
UploadInput describes a file and its owner for the shared upload pipeline.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.