Documentation
¶
Index ¶
- func CheckIsRootUser(ctx context.Context, userID string) bool
- type Demo
- type DemoQueryOptions
- type DemoQueryParam
- type DemoQueryResult
- type Demos
- type Dict
- type DictItem
- type DictItemQueryOptions
- type DictItemQueryParam
- type DictItemQueryResult
- type DictItems
- type DictQueryOptions
- type DictQueryParam
- type DictQueryResult
- type Dicts
- type ErrorItem
- type ErrorResult
- type IDResult
- type ListResult
- type Menu
- type MenuAction
- type MenuActionQueryOptions
- type MenuActionQueryParam
- type MenuActionQueryResult
- type MenuActionResource
- type MenuActionResourceQueryOptions
- type MenuActionResourceQueryParam
- type MenuActionResourceQueryResult
- type MenuActionResources
- type MenuActions
- type MenuQueryOptions
- type MenuQueryParam
- type MenuQueryResult
- type MenuTree
- type MenuTrees
- type Menus
- type OrderDirection
- type OrderField
- type PaginationParam
- type PaginationResult
- type Role
- type RoleMenu
- type RoleMenuQueryOptions
- type RoleMenuQueryParam
- type RoleMenuQueryResult
- type RoleMenus
- type RoleQueryOptions
- type RoleQueryParam
- type RoleQueryResult
- type Roles
- type SignInCaptcha
- type SignInParam
- type SignInTokenInfo
- type StatusResult
- type StatusText
- type UpdatePasswordParam
- type User
- type UserQueryOptions
- type UserQueryParam
- type UserQueryResult
- type UserRole
- type UserRoleQueryOptions
- type UserRoleQueryParam
- type UserRoleQueryResult
- type UserRoles
- type UserShow
- type UserShowQueryResult
- type UserShows
- type UserSignInInfo
- type Users
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Demo ¶
type Demo struct {
ID string `json:"id" ` // 唯一标识
Code string `json:"code" binding:"required"` // 编号
Name string `json:"name" binding:"required"` // 名称
Memo string `json:"memo"` // 备注
Status int `json:"status" binding:"required,max=2,min=1"` // 状态(1:启用 2:停用)
Sort int `json:"sort,omitempty"`
Creator string `json:"creator" ` // 创建者
CreatedAt *time.Time `json:"created_at" ` // 创建时间
UpdatedAt *time.Time `json:"updated_at" ` // 更新时间
}
Demo 示例对象
type DemoQueryOptions ¶
type DemoQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
DemoQueryOptions 示例对象查询可选参数项
type DemoQueryParam ¶
type DemoQueryParam struct {
PaginationParam
Code string `form:"-"` // 编号
QueryValue string `form:"queryValue"` // 查询值
}
DemoQueryParam 查询条件
type DemoQueryResult ¶
type DemoQueryResult struct {
Data []*Demo
PageResult *PaginationResult
}
DemoQueryResult 示例对象查询结果
type Dict ¶ added in v1.0.5
type Dict struct {
ID string `json:"id" ` // 唯一标识
NameCn string `json:"name_cn" binding:"required"` // 字典名(中)
NameEn string `json:"name_en" binding:"required"` // 字典名(英)
Status int `json:"status" binding:"required"` // 状态
Memo string `json:"memo"` // 备注
Sort int `json:"sort"` // 排序
Creator string `json:"creator"` // 创建者
CreatedAt time.Time `json:"created_at"` // 创建时间
UpdatedAt time.Time `json:"updated_at"` // 更新时间
Items DictItems `json:"items" binding:"required,gt=0"` // 字典项列表
}
Dict 字典对象
type DictItem ¶ added in v1.0.5
type DictItem struct {
ID string `json:"id"` // 唯一标识
Label string `json:"label" binding:"required"` // 显示值
Value int `json:"value" binding:"required"` // 字典值
Status int `json:"status" binding:"required"` // 状态(1:启用 2:禁用)
DictID string `json:"dict_id" binding:"required"` // dict.id
Memo string `json:"memo"` // 备注
Sort int `json:"sort"` // 排序
Creator string `json:"creator"` // 创建者
CreatedAt time.Time `json:"created_at"` // 创建时间
UpdatedAt time.Time `json:"updated_at"` // 更新时间
}
DictItem 字典项对象
type DictItemQueryOptions ¶ added in v1.0.5
type DictItemQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
DictItemQueryOptions 查询可选参数项
type DictItemQueryParam ¶ added in v1.0.5
type DictItemQueryParam struct {
PaginationParam
DictID string //字典id
IDs []string
}
DictItemQueryParam 查询条件
type DictItemQueryResult ¶ added in v1.0.5
type DictItemQueryResult struct {
Data DictItems
PageResult *PaginationResult
}
DictItemQueryResult 查询结果
type DictQueryOptions ¶ added in v1.0.5
type DictQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
DictQueryOptions 查询可选参数项
type DictQueryParam ¶ added in v1.0.5
type DictQueryParam struct {
PaginationParam
IDs []string `form:"-"` // 唯一标识列表
NameCn string `form:"-"` // 字典名称(中)
NameEn string `form:"-"` // 字典名称(英)
QueryValue string `form:"queryValue"` // 模糊查询
Status int16 `form:"status"` // 状态(1:启用 2:禁用)
SqlRaw string
}
DictQueryParam 查询条件
type DictQueryResult ¶ added in v1.0.5
type DictQueryResult struct {
Data Dicts
PageResult *PaginationResult
}
DictQueryResult 查询结果
type ErrorResult ¶
type ErrorResult struct {
Error ErrorItem `json:"error"` // 错误项
}
ErrorResult 响应错误
type ListResult ¶
type ListResult struct {
List interface{} `json:"list"`
Pagination *PaginationResult `json:"pagination,omitempty"`
}
ListResult 响应列表数据
type Menu ¶
type Menu struct {
ID string `json:"id"` // 唯一标识
Name string `json:"name" binding:"required"` // 菜单名称
Sort int `json:"sort"` // 排序值
Icon string `json:"icon"` // 菜单图标
Router string `json:"router"` // 访问路由
ParentID string `json:"parent_id"` // 父级ID
ParentPath string `json:"parent_path"` // 父级路径
Status int `json:"status" binding:"required,max=2,min=1"` // 状态(1:启用 2:禁用)
Memo string `json:"memo"` // 备注
IsShow *bool `json:"is_show"` // 是否显示
Creator string `json:"creator" ` // 创建者
CreatedAt *time.Time `json:"created_at" ` // 创建时间
UpdatedAt *time.Time `json:"updated_at" ` // 更新时间
Actions MenuActions `json:"actions" ` // 动作列表
}
Menu 菜单对象
type MenuAction ¶
type MenuAction struct {
ID string `yaml:"-" json:"id" ` // 唯一标识
MenuID string `yaml:"-" binding:"required" json:"menu_id"` // 菜单ID
Code string `yaml:"code" binding:"required" json:"code"` // 动作编号
Name string `yaml:"name" binding:"required" json:"name"` // 动作名称
Resources MenuActionResources `yaml:"resources,omitempty" json:"resources"` // 资源列表
}
MenuAction 菜单动作对象
type MenuActionQueryOptions ¶
type MenuActionQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
MenuActionQueryOptions 查询可选参数项
type MenuActionQueryParam ¶
type MenuActionQueryParam struct {
PaginationParam
MenuID string // 菜单ID
IDs []string // 唯一标识列表
}
MenuActionQueryParam 查询条件
type MenuActionQueryResult ¶
type MenuActionQueryResult struct {
Data MenuActions
PageResult *PaginationResult
}
MenuActionQueryResult 查询结果
type MenuActionResource ¶
type MenuActionResource struct {
ID string `yaml:"-" json:"id" ` // 唯一标识
ActionID string `yaml:"-" json:"action_id"` // 菜单动作ID
Method string `yaml:"method" binding:"required" json:"method"` // 资源请求方式(支持正则)
Path string `yaml:"path" binding:"required" json:"path"` // 资源请求路径(支持/:id匹配)
}
MenuActionResource 菜单动作关联资源对象
type MenuActionResourceQueryOptions ¶
type MenuActionResourceQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
MenuActionResourceQueryOptions 查询可选参数项
type MenuActionResourceQueryParam ¶
type MenuActionResourceQueryParam struct {
PaginationParam
MenuID string // 菜单ID
MenuIDs []string // 菜单ID列表
}
MenuActionResourceQueryParam 查询条件
type MenuActionResourceQueryResult ¶
type MenuActionResourceQueryResult struct {
Data MenuActionResources
PageResult *PaginationResult
}
MenuActionResourceQueryResult 查询结果
type MenuActionResources ¶
type MenuActionResources []*MenuActionResource
MenuActionResources 菜单动作关联资源管理列表
func (MenuActionResources) ToActionIDMap ¶
func (a MenuActionResources) ToActionIDMap() map[string]MenuActionResources
ToActionIDMap 转换为动作ID映射
func (MenuActionResources) ToMap ¶
func (a MenuActionResources) ToMap() map[string]*MenuActionResource
ToMap 转换为map
type MenuActions ¶
type MenuActions []*MenuAction
MenuActions 菜单动作管理列表
func (MenuActions) FillResources ¶
func (a MenuActions) FillResources(mResources map[string]MenuActionResources)
FillResources 填充资源数据
func (MenuActions) ToMenuIDMap ¶
func (a MenuActions) ToMenuIDMap() map[string]MenuActions
ToMenuIDMap 转换为菜单ID映射
type MenuQueryOptions ¶
type MenuQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
MenuQueryOptions 查询可选参数项
type MenuQueryParam ¶
type MenuQueryParam struct {
PaginationParam
IDs []string `form:"-"` // 唯一标识列表
Name string `form:"-"` // 菜单名称
PrefixParentPath string `form:"-"` // 父级路径(前缀模糊查询)
QueryValue string `form:"queryValue"` // 模糊查询
ParentID *string `form:"parentID"` // 父级内码
IsShow *bool `form:"isShow"`
Status int16 `form:"status"` // 状态(1:启用 2:禁用)
}
MenuQueryParam 查询条件
type MenuQueryResult ¶
type MenuQueryResult struct {
Data Menus
PageResult *PaginationResult
}
MenuQueryResult 查询结果
type MenuTree ¶
type MenuTree struct {
ID string `yaml:"-" json:"id"` // 唯一标识
Name string `yaml:"name" json:"name"` // 菜单名称
Icon string `yaml:"icon" json:"icon"` // 菜单图标
Router string `yaml:"router,omitempty" json:"router"` // 访问路由
ParentID string `yaml:"-" json:"parent_id"` // 父级ID
ParentPath string `yaml:"-" json:"parent_path"` // 父级路径
Sort int `yaml:"sort" json:"sort"` // 排序值
IsShow *bool `json:"is_show"`
Status int `yaml:"-" json:"status"` // 状态(1:启用 2:禁用)
Actions MenuActions `yaml:"actions,omitempty" json:"actions"` // 动作列表
Children *MenuTrees `yaml:"children,omitempty" json:"children,omitempty"` // 子级树
}
MenuTree 菜单树
type Menus ¶
type Menus []*Menu
Menus 菜单列表
func (Menus) FillMenuAction ¶
func (a Menus) FillMenuAction(mActions map[string]MenuActions) Menus
FillMenuAction 填充菜单动作列表
type OrderDirection ¶
type OrderDirection int
OrderDirection 排序方向
const ( // OrderByASC 升序排序 OrderByASC OrderDirection = 1 // OrderByDESC 降序排序 OrderByDESC OrderDirection = 2 )
type OrderField ¶
type OrderField struct {
Key string // 字段名(字段名约束为小写蛇形)
Direction OrderDirection // 排序方向
}
OrderField 排序字段
func NewOrderField ¶
func NewOrderField(key string, d OrderDirection) *OrderField
NewOrderField 创建排序字段
func NewOrderFieldWithKeys ¶
func NewOrderFieldWithKeys(keys []string, directions ...map[int]OrderDirection) []*OrderField
NewOrderFieldWithKeys 创建排序字段(默认升序排序),可指定不同key的排序规则 keys 需要排序的key directions 排序规则,按照key的索引指定,索引默认从0开始
func NewOrderFields ¶
func NewOrderFields(orderFields ...*OrderField) []*OrderField
NewOrderFields 创建排序字段列表
type PaginationParam ¶
type PaginationParam struct {
Pagination bool `form:"-"` // 是否使用分页查询
OnlyCount bool `form:"-"` // 是否仅查询count
Current uint `form:"current,default=1"` // 当前页
PageSize uint `form:"pageSize,default=10" binding:"max=100"` // 页大小
}
PaginationParam 分页查询条件
func (PaginationParam) Limit ¶ added in v1.0.6
func (a PaginationParam) Limit() int
func (PaginationParam) Offset ¶ added in v1.0.6
func (a PaginationParam) Offset() int
type PaginationResult ¶
type PaginationResult struct {
Total int `json:"total"`
Current uint `json:"current"`
PageSize uint `json:"pageSize"`
}
PaginationResult 分页查询结果
type Role ¶
type Role struct {
ID string `json:"id" ` // 唯一标识
Name string `json:"name" binding:"required"` // 角色名称
Sort int `json:"sort"` // 排序值
Memo string `json:"memo"` // 备注
Status int `json:"status" binding:"required,max=2,min=1"` // 状态(1:启用 2:禁用)
Creator string `json:"creator" ` // 创建者
CreatedAt *time.Time `json:"created_at" ` // 创建时间
UpdatedAt *time.Time `json:"updated_at" ` // 更新时间
RoleMenus RoleMenus `json:"role_menus" binding:"required,gt=0"` // 角色菜单列表
}
Role 角色对象
type RoleMenu ¶
type RoleMenu struct {
ID string `json:"id"` // 唯一标识
RoleID string `json:"role_id" binding:"required"` // 角色ID
MenuID string `json:"menu_id" binding:"required"` // 菜单ID
ActionID string `json:"action_id" binding:"required"` // 动作ID
}
RoleMenu 角色菜单对象
type RoleMenuQueryOptions ¶
type RoleMenuQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
RoleMenuQueryOptions 查询可选参数项
type RoleMenuQueryParam ¶
type RoleMenuQueryParam struct {
PaginationParam
RoleID string // 角色ID
RoleIDs []string // 角色ID列表
}
RoleMenuQueryParam 查询条件
type RoleMenuQueryResult ¶
type RoleMenuQueryResult struct {
Data RoleMenus
PageResult *PaginationResult
}
RoleMenuQueryResult 查询结果
type RoleMenus ¶
type RoleMenus []*RoleMenu
RoleMenus 角色菜单列表
func (RoleMenus) ToRoleIDMap ¶
ToRoleIDMap 转换为角色ID映射
type RoleQueryOptions ¶
type RoleQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
RoleQueryOptions 查询可选参数项
type RoleQueryParam ¶
type RoleQueryParam struct {
PaginationParam
IDs []string `form:"-"` // 唯一标识列表
Name string `form:"-"` // 角色名称
QueryValue string `form:"queryValue"` // 模糊查询
UserID string `form:"-"` // 用户ID
Status int `form:"status"` // 状态(1:启用 2:禁用)
}
RoleQueryParam 查询条件
type RoleQueryResult ¶
type RoleQueryResult struct {
Data Roles
PageResult *PaginationResult
}
RoleQueryResult 查询结果
type SignInCaptcha ¶
type SignInCaptcha struct {
CaptchaID string `json:"captcha_id"` // 验证码ID
}
SignInCaptcha 登录验证码
type SignInParam ¶
type SignInParam struct {
UserName string `json:"user_name" binding:"required"` // 用户名
Password string `json:"password" binding:"required"` // 密码(md5加密)
CaptchaID string `json:"captcha_id" binding:"required"` // 验证码ID
CaptchaCode string `json:"captcha_code" binding:"required"` // 验证码
}
SignInParam 登录参数
type SignInTokenInfo ¶
type SignInTokenInfo struct {
AccessToken string `json:"access_token"` // 访问令牌
TokenType string `json:"token_type"` // 令牌类型
ExpiresAt int64 `json:"expires_at"` // 令牌到期时间戳
}
SignInTokenInfo 登录令牌信息
type StatusResult ¶
type StatusResult struct {
Status StatusText `json:"status"` // 状态(OK)
}
StatusResult 响应状态
type StatusText ¶
type StatusText string
StatusText 定义状态文本
const ( OKStatus StatusText = "OK" ErrorStatus StatusText = "ERROR" FailStatus StatusText = "FAIL" )
定义HTTP状态文本常量
func (StatusText) String ¶
func (t StatusText) String() string
type UpdatePasswordParam ¶
type UpdatePasswordParam struct {
OldPassword string `json:"old_password" binding:"required"` // 旧密码(md5加密)
NewPassword string `json:"new_password" binding:"required"` // 新密码(md5加密)
}
UpdatePasswordParam 更新密码请求参数
type User ¶
type User struct {
ID string `json:"id" ` // 唯一标识
UserName string `json:"user_name" binding:"required"` // 用户名
RealName string `json:"real_name"` // 真实姓名
FirstName string `json:"first_name" binding:"required"` // 真实姓名
LastName string `json:"last_name" binding:"required"` // 真实姓名
Password string `json:"password"` // 密码
Phone string `json:"phone"` // 手机号
Email string `json:"email"` // 邮箱
Status int16 `json:"status" binding:"required,max=2,min=1"` // 用户状态(1:启用 2:停用)
Gender int `json:"gender" binding:"max=3,min=1"` // 性别(1:男,2:女)
Creator string `json:"creator" ` // 创建者
CreatedAt time.Time `json:"created_at" ` // 创建时间
UpdatedAt time.Time `json:"updated_at" ` // 创建时间
UserRoles UserRoles `json:"user_roles" binding:"required,gt=0"` // 角色授权
}
User 用户对象
type UserQueryOptions ¶
type UserQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
UserQueryOptions 查询可选参数项
type UserQueryParam ¶
type UserQueryParam struct {
PaginationParam
UserName string `form:"userName"` // 用户名
QueryValue string `form:"queryValue"` // 模糊查询
Status int16 `form:"status"` // 用户状态(1:启用 2:停用)
RoleIDs []string `form:"-"` // 角色ID列表
}
UserQueryParam 查询条件
type UserQueryResult ¶
type UserQueryResult struct {
Data Users
PageResult *PaginationResult
}
UserQueryResult 查询结果
func (UserQueryResult) ToShowResult ¶
func (a UserQueryResult) ToShowResult(mUserRoles map[string]UserRoles, mRoles map[string]*Role) *UserShowQueryResult
ToShowResult 转换为显示结果
type UserRole ¶
type UserRole struct {
ID string `json:"id"` // 唯一标识
UserID string `json:"user_id"` // 用户ID
RoleID string `json:"role_id"` // 角色ID
}
UserRole 用户角色
type UserRoleQueryOptions ¶
type UserRoleQueryOptions struct {
OrderFields []*OrderField // 排序字段
}
UserRoleQueryOptions 查询可选参数项
type UserRoleQueryParam ¶
type UserRoleQueryParam struct {
PaginationParam
UserID string // 用户ID
UserIDs []string // 用户ID列表
}
UserRoleQueryParam 查询条件
type UserRoleQueryResult ¶
type UserRoleQueryResult struct {
Data UserRoles
PageResult *PaginationResult
}
UserRoleQueryResult 查询结果
type UserRoles ¶
type UserRoles []*UserRole
UserRoles 角色菜单列表
func (UserRoles) ToUserIDMap ¶
ToUserIDMap 转换为用户ID映射
type UserShow ¶
type UserShow struct {
ID string `json:"id"` // 唯一标识
UserName string `json:"user_name"` // 用户名
RealName string `json:"real_name"` // 真实姓名
FirstName string `json:"first_name"` // 真实名
LastName string `json:"last_name"` // 真实姓
Phone string `json:"phone"` // 手机号
Email string `json:"email"` // 邮箱
Status int `json:"status"` // 用户状态(1:启用 2:停用)
CreatedAt time.Time `json:"created_at"` // 创建时间
Roles []*Role `json:"roles"` // 授权角色列表
}
UserShow 用户显示项
type UserShowQueryResult ¶
type UserShowQueryResult struct {
Data UserShows
PageResult *PaginationResult
}
UserShowQueryResult 用户显示项查询结果
type UserSignInInfo ¶
type UserSignInInfo struct {
UserID string `json:"user_id"` // 用户ID
UserName string `json:"user_name"` // 用户名
RealName string `json:"real_name"` // 真实姓名
FistName string `json:"first_name"` // 真实姓名
LastName string `json:"last_name"` // 真实姓名
Roles Roles `json:"roles"` // 角色列表
}
UserSignInInfo 用户登录信息