Documentation ¶
Index ¶
- type AliyunAccessToken
- type AliyunOSS
- type AliyunSdkConf
- type AliyunSdkConfList
- type AliyunSdkConfToken
- type AliyunToken
- type Area
- type AreaListRes
- type AuthHookFunc
- type AuthHookInfo
- type BaiduSdkConf
- type BaiduSdkConfAccessToken
- type BaiduSdkConfList
- type BaiduSdkConfToken
- type BaiduSdkOCRBankCard
- type BaiduSdkOCRIDCard
- type BaiduSdkOCRIDCardA
- type BaiduSdkOCRIDCardB
- type BankCardWithOCR
- type BankCardWithOCRInput
- type BusinessLicenseOCR
- type BusinessLicenseWithOCR
- type CasbinHookFunc
- type CasbinHookInfo
- type CollectRes
- type CtyunSdkConf
- type CtyunSdkConfInfo
- type CtyunSdkConfList
- type ExportFilter
- type FileHookFunc
- type FileHookInfo
- type FileInfo
- type FileUploadInput
- type FilterInfo
- type ForgotPassword
- type HookEventType
- type HookFunc
- type HuaweiAccessToken
- type HuaweiOSS
- type HuaweiSdkConf
- type HuaweiSdkConfList
- type HuaweiSdkConfToken
- type HuaweiToken
- type IDCardWithOCR
- type JwtCustomClaims
- type JwtHookFunc
- type JwtHookInfo
- type KeyValueT
- type LocalOSS
- type LoginByMobileInfo
- type LoginInfo
- type MinioOSS
- type OCRBankCard
- type OCRBusinessLicense
- type OCRIDCardFileUploadInput
- type OSSType
- type OrderBy
- type OrganizationInfoListRes
- type Oss
- type Pagination
- type PaginationRes
- type PlatUser
- type QiniuOSS
- type ReqCasbin
- type RoleListRes
- type SearchParams
- type SessionContext
- type SysMenu
- type SysMenuTree
- type SysOrganizationInfo
- type SysOrganizationTree
- type SysPermission
- type SysPermissionInfoListRes
- type SysPermissionInfoRes
- type SysPermissionInfoTreeRes
- type SysRole
- type SysUser
- type SysUserList
- type SysUserListRes
- type SysUserRegister
- type SysUserRegisterRes
- type TableCacheConf
- type TencentAccessToken
- type TencentOSS
- type TencentSdkConf
- type TencentSdkConfList
- type TencentSdkConfToken
- type TencentToken
- type TokenInfo
- type UpdateUserPassword
- type UserExtendMap
- type UserHookFunc
- type UserHookInfo
- type UserInnerRegister
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AliyunAccessToken ¶
type AliyunAccessToken struct { NlsRequestId string `json:"NlsRequestId" dc:"该参数可忽略"` RequestId string `json:"RequestId" dc:"该参数忽略,请求ID"` AliyunToken AliyunToken `json:"Token" dc:"token信息"` }
AliyunAccessToken 阿里云平台返回的Token
type AliyunSdkConf ¶
type AliyunSdkConf struct { Identifier string `json:"identifier" v:"required#业务标识符参数错误" dc:"业务标识符,唯一,且不可修改"` Description string `json:"description" dc:"描述"` AppID string `json:"appID" v:"required#请输入 AppID" dc:"AppID"` AESKey string `json:"aesKey" v:"required#请输入 AES Key" dc:"AES Key"` APIKey string `json:"apiKey" v:"required#请输入 API Key" dc:"API Key"` SecretKey string `json:"secretKey" v:"required#请输入 Secret Key" dc:"Secret Key"` }
type AliyunSdkConfList ¶
type AliyunSdkConfList CollectRes[AliyunSdkConf]
type AliyunSdkConfToken ¶
type AliyunSdkConfToken struct { AliyunSdkConf AliyunAccessToken }
type AliyunToken ¶
type Area ¶
type Area struct { Id int64 `json:"id" description:"ID"` AreaCode int `json:"areaCode" description:"地区编码"` AreaName string `json:"areaName" description:"地区名称"` Level int `json:"level" description:"1:省份province,2:市city,3:区县district,4:街道street"` LatLongCenter string `json:"latLongCenter" description:"城市中心点(即经纬度)"` ParentId int64 `json:"parentId" description:"地区父节点"` }
type AreaListRes ¶
type AreaListRes CollectRes[Area]
type AuthHookFunc ¶ added in v0.2.0
type AuthHookFunc func(ctx context.Context, actionType sys_enum.AuthActionType, info sys_entity.SysUser) error
type AuthHookInfo ¶ added in v0.2.0
type AuthHookInfo struct { Key sys_enum.AuthActionType Value AuthHookFunc UserType sys_enum.UserType `json:"userType" dc:"用户类型"` }
type BaiduSdkConf ¶
type BaiduSdkConf struct { Identifier string `json:"identifier" v:"required#业务标识符参数错误" dc:"业务标识符,唯一,且不可修改"` Description string `json:"description" dc:"描述"` AppID string `json:"appID" v:"required#请输入 AppID" dc:"AppID"` AESKey string `json:"aesKey" v:"required#请输入 AES Key" dc:"AES Key"` APIKey string `json:"apiKey" v:"required#请输入 API Key" dc:"API Key"` SecretKey string `json:"secretKey" v:"required#请输入 Secret Key" dc:"Secret Key"` }
type BaiduSdkConfAccessToken ¶
type BaiduSdkConfAccessToken struct { AccessToken string `json:"access_token" dc:"获取的Access Token"` ExpiresIn int64 `json:"expires_in" dc:"Access Token的有效期(秒为单位,有效期30天)"` Scope string `json:"scope" dc:"该参数忽略"` SessionKey string `json:"session_key" dc:"该参数忽略"` SessionSecret string `json:"session_secret" dc:"该参数忽略"` // contains filtered or unexported fields }
type BaiduSdkConfList ¶
type BaiduSdkConfList CollectRes[BaiduSdkConf]
type BaiduSdkConfToken ¶
type BaiduSdkConfToken struct { BaiduSdkConf BaiduSdkConfAccessToken }
type BaiduSdkOCRBankCard ¶
type BaiduSdkOCRBankCard struct {
OCRBankCard
}
type BaiduSdkOCRIDCard ¶
type BaiduSdkOCRIDCard struct { OCRIDCardA *BaiduSdkOCRIDCardA `json:"ocrIDCardA" dc:"身份证头像面识别的信息"` OCRIDCardB *BaiduSdkOCRIDCardB `json:"ocrIDCardB" dc:"身份证国徽面识别的信息"` }
type BaiduSdkOCRIDCardA ¶
type BaiduSdkOCRIDCardA struct { Direction int `json:"direction" dc:"图像方向:-1 为定义,0正向,1逆时针90度,2逆时针180度,3逆时针270度"` ImageStateText string `` /* 310-byte string literal not displayed */ RiskType string `` /* 135-byte string literal not displayed */ Address string `json:"address" dc:"地址信息"` IDCardNumber string `json:"idCardNumber" dc:"身份证号"` Birthday string `json:"birthday" dc:"出生日期"` Realname string `json:"realname" dc:"姓名"` Gender string `json:"gender" dc:"性别"` Nation string `json:"nation" dc:"民族"` }
type BaiduSdkOCRIDCardB ¶
type BankCardWithOCR ¶
type BankCardWithOCR struct { // 上传文件返回数据 sys_entity.SysFile // SDK返回的识别数据 BaiduSdkOCRBankCard }
BankCardWithOCR 银行卡识别响应信息
type BankCardWithOCRInput ¶
type BankCardWithOCRInput struct {
FileUploadInput
}
BankCardWithOCRInput 上传银行卡请求参数
type BusinessLicenseOCR ¶
type BusinessLicenseOCR struct { Direction int `json:"direction" dc:"图像方向:-1 为定义,0正向,1逆时针90度,2逆时针180度,3逆时针270度"` RiskType string `json:"riskType" dc:"风险类型:normal正常营业执照,copy复印件,screen翻拍,scan扫描,unknown其他未知情况"` CreditCode string `json:"creditCode" dc:"社会信用代码"` CombiningForm string `json:"combiningForm" dc:"组成形式"` BusinessScope string `json:"businessScope" dc:"经营范围"` EstablishmentDate string `json:"establishmentDate" dc:"成立日期"` LegalPerson string `json:"legalPerson" dc:"法人"` RegisteredCapital string `json:"registeredCapital" dc:"注册资本"` CertificateNumber string `json:"certificateNumber" dc:"证件编号"` RegisteredAddress string `json:"registeredAddress" dc:"注册地址"` CompanyName string `json:"companyName" dc:"主体名称"` ExpirationDate string `json:"expirationDate" dc:"有效期"` ApprovalDate string `json:"approvalDate" dc:"核准日期"` RegistrationDate string `json:"RegistrationDate" dc:"核准日期"` }
type BusinessLicenseWithOCR ¶
type BusinessLicenseWithOCR struct { sys_entity.SysFile BusinessLicenseOCR }
BusinessLicenseWithOCR 营业执照识别响应信息
type CasbinHookFunc ¶ added in v0.2.21
type CasbinHookInfo ¶ added in v0.2.21
type CasbinHookInfo HookEventType[sys_enum.UserType, CasbinHookFunc]
type CollectRes ¶ added in v0.2.0
type CollectRes[T any] struct { List *[]T `json:"list" dc:"数据列表"` PaginationRes }
CollectRes 集合信息
type CtyunSdkConf ¶
type CtyunSdkConf struct { Identifier string `json:"identifier" v:"required#业务标识符参数错误" dc:"业务标识符,唯一,且不可修改"` Description string `json:"description" dc:"描述"` AppID string `json:"appID" v:"required#请输入 AppID" dc:"应用AppID"` AppKey string `json:"appKey" v:"required#请输入 API Key" dc:"应用API Key"` AppSecret string `json:"appSecret" v:"required#请输入 Secret Key" dc:"应用AppSecret"` AccessKey string `json:"accessKey" v:"required#请输入 AccessKey" dc:"账户的AES Key"` SecurityKey string `json:"security_key" v:"required#请输入 SecurityKey" dc:"账户的 SecurityKey"` }
CtyunSdkConf天翼云服务配置信息
type ExportFilter ¶ added in v0.2.0
type ExportFilter struct { Fields []FilterInfo `json:"filter" dc:"搜索字段集"` Pagination }
ExportFilter 数据查询字段条件信息集合
type FileHookFunc ¶ added in v0.2.0
type FileHookFunc HookFunc[sys_enum.UploadEventState, sys_entity.SysFile]
type FileHookInfo ¶ added in v0.2.0
type FileHookInfo HookEventType[sys_enum.UploadEventState, FileHookFunc]
type FileUploadInput ¶
type FileUploadInput struct { File *ghttp.UploadFile `json:"sys_file" type:"sys_file" dc:"请选择文件,以form-data方式提交"` // 上传文件对象 Name string `json:"name" dc:"自定义文件名"` // 自定义文件名称 RandomName bool `json:"randomName" dc:"是否随机文件名" default:"true"` // 是否随机命名文件 }
FileUploadInput 上传文件输入参数
type FilterInfo ¶ added in v0.2.0
type FilterInfo struct { Field string `json:"filed" v:"required" dc:"字段名称"` Where string `` /* 136-byte string literal not displayed */ IsOrWhere bool `json:"isOrWhere" dc:"是否或与条件"` Value interface{} `json:"value" dc:"字段对应值,如果是between的值,则用逗号隔开"` IsNullValue bool `json:"isNullValue" dc:"是否空值"` Modifier string `json:"modifier" v:"in:is,not,is not" dc:"修饰条件,支持:like,in,between"` }
FilterInfo 数据查询字段条件信息
type ForgotPassword ¶
type HookEventType ¶
type HuaweiAccessToken ¶
type HuaweiAccessToken struct { AccessToken string `json:"access_token" dc:"token值"` TokenType string `json:"token_type" dc:"token类型"` ExpiresIn int `json:"expires_in" dc:"token有效期" ` Scope string `json:"scope" dc:"该参数可忽略"` PlatUser PlatUser `json:"plat_user"` }
HuaweiAccessToken 华为云平台返回的Token
type HuaweiSdkConf ¶
type HuaweiSdkConf struct { Identifier string `json:"identifier" v:"required#业务标识符参数错误" dc:"业务标识符,唯一,且不可修改"` Description string `json:"description" dc:"描述"` AppID string `json:"appID" v:"required#请输入 AppID" dc:"AppID"` AESKey string `json:"aesKey" v:"required#请输入 AES Key" dc:"AES Key"` APIKey string `json:"apiKey" v:"required#请输入 API Key" dc:"API Key"` SecretKey string `json:"secretKey" v:"required#请输入 Secret Key" dc:"Secret Key"` }
type HuaweiSdkConfList ¶
type HuaweiSdkConfList CollectRes[HuaweiSdkConf]
type HuaweiSdkConfToken ¶
type HuaweiSdkConfToken struct { HuaweiSdkConf HuaweiAccessToken }
HuaweiSdkConfToken 配置信息 + Token信息
type HuaweiToken ¶
type IDCardWithOCR ¶
type IDCardWithOCR struct { sys_entity.SysFile BaiduSdkOCRIDCard }
IDCardWithOCR 身份证识别响应信息
type JwtCustomClaims ¶
type JwtCustomClaims struct { sys_entity.SysUser UnionMainId int64 `json:"unionMainId" description:"主体id"` IsAdmin bool jwt.RegisteredClaims }
type JwtHookFunc ¶ added in v0.2.29
type JwtHookFunc func(ctx context.Context, claims *JwtCustomClaims) (*JwtCustomClaims, error)
type JwtHookInfo ¶ added in v0.2.29
type JwtHookInfo HookEventType[sys_enum.UserType, JwtHookFunc]
type LoginByMobileInfo ¶
type OCRBankCard ¶
type OCRBankCard struct { Direction int `json:"direction" dc:"图像方向:-1 为定义,0正向,1逆时针90度,2逆时针180度,3逆时针270度"` BankCardNumber string `json:"bankCardNumber" dc:"银行卡号"` ValidDate string `json:"validDate" dc:"有效期"` BankCardType int `json:"bankCardType" dc:"银行卡类型"` BankName string `json:"bankName" dc:"银行名字"` HolderName string `json:"holderName" dc:"持卡人名字"` }
type OCRBusinessLicense ¶
type OCRBusinessLicense struct {
FileUploadInput
}
OCRBusinessLicense 上传新版营业执照
type OCRIDCardFileUploadInput ¶
type OCRIDCardFileUploadInput struct { FileUploadInput DetectRisk string `` /* 200-byte string literal not displayed */ IDCardSide string `` /* 301-byte string literal not displayed */ }
OCRIDCardFileUploadInput 上传身份证请求参数
type OrderBy ¶ added in v0.2.0
type OrderBy struct { Field string `json:"field" dc:"排序字段,多个用半角逗号隔开"` Sort string `json:"sort" v:"in:asc,desc" dc:"排序规则,支持asc,desc" default:"ASC"` }
OrderBy 排序规则
type OrganizationInfoListRes ¶
type OrganizationInfoListRes CollectRes[sys_entity.SysOrganization]
type Pagination ¶ added in v0.2.0
type Pagination struct { Page int `json:"page" v:"min:1#当前页不能小于1" default:"1" dc:"当前页"` PageSize int `json:"pageSize" v:"min:10|max:500#每页数量不能小于10|每页数量不能大于500" default:"20" dc:"每页数量"` }
Pagination 分页信息
type PaginationRes ¶ added in v0.2.0
type PaginationRes struct { Pagination PageTotal int `json:"pageTotal" dc:"总页数"` Total int64 `json:"total" dc:"总条数"` }
type PlatUser ¶
type PlatUser struct { UserID int `json:"userId" dc:"用户id"` UserNo string `json:"userNo" dc:"编号"` UserName string `json:"userName" dc:"用户名"` UserType string `json:"userType" dc:"用户类型"` Phone interface{} `json:"phone" dc:"电话"` TenantID int `json:"tenantId"` Status string `json:"status"` DeleteFlag int `json:"deleteFlag"` PwdUpdateDate time.Time `json:"pwdUpdateDate"` UserExtendMap UserExtendMap `json:"userExtendMap"` Password interface{} `json:"password"` Salt interface{} `json:"salt"` CurrentLoginType string `json:"currentLoginType"` }
type QiniuOSS ¶
type QiniuOSS struct { Zone string `json:"zone"` // 存储区域 Bucket string `json:"bucket"` // 空间名称 ImgPath string `json:"imgPath"` // CDN加速域名 UseHTTPS bool `json:"useHTTPS"` // 是否使用https AccessKey string `json:"accessKey"` // 秘钥AK SecretKey string `json:"secretKey"` // 秘钥SK UseCdnDomains bool `json:"useCdnDomains"` // 上传是否使用CDN上传加速 }
type RoleListRes ¶
type RoleListRes CollectRes[sys_entity.SysRole]
type SearchParams ¶ added in v0.2.0
type SearchParams struct { Filter []FilterInfo `json:"filter" dc:"搜索字段集"` OrderBy []OrderBy `json:"orderBy" dc:"排序字段集"` Pagination }
SearchParams 数据查询字段条件信息集合
type SessionContext ¶
type SessionContext struct { JwtClaimsUser *JwtCustomClaims // 上下文用户信息 Ipv4 string // 客户端IP地址 SessionErrorQueue *garray.Array // 会话错误队列 }
SessionContext 请求上下文结构
type SysMenu ¶
type SysMenu struct { Id int64 `json:"id" dc:"ID,ID值为0时则新增菜单" v:"min:0#ID不能小于0"` Path string `json:"path" dc:"路径" v:"max-length:128#路径最大长度请不要超过128字符"` Name string `json:"name" dc:"名称" v:"required|max-length:128#请输入名称|名称最大长度请不要超过128字符"` Redirect string `json:"redirect" dc:"跳转" v:"max-length:128#跳转URL最大长度请不要超过128字符"` Title string `json:"title" dc:"标题" v:"required|max-length:64#请输入标题|标题最大长度请不要超过128字符"` Icon string `json:"icon" dc:"图标" v:"max-length:128#图标名称最大长度请不要超过128字符"` Component string `json:"component" dc:"组件" v:"max-length:128#组件地址最大长度请不要超过128字符"` ParentId int64 `json:"parentId" dc:"所属父级" v:"integer|min:0#父级ID参数错误|父级ID不能小于0"` Sort int `json:"sort" dc:"排序" v:"integer#排序参数错误"` State int `json:"state" dc:"状态:0隐藏,1显示" v:"in:0,1#请选择状态类型"` }
type SysMenuTree ¶
type SysMenuTree struct { sys_entity.SysMenu Children *[]SysMenuTree }
type SysOrganizationInfo ¶
type SysOrganizationTree ¶
type SysOrganizationTree struct { SysOrganizationInfo CascadeDeep int `json:"cascadeDeep" description:"级联深度" v:"min:0"` Children *[]SysOrganizationTree `json:"children" orm:"-" dc:"下级组织架构"` }
type SysPermission ¶
type SysPermission struct { Id int64 `json:"id" dc:"ID" v:"integer"` ParentId int64 `json:"parentId" dc:"父级ID" v:"min:0#必须是正整数,该属性创建后不支持修改"` Name string `json:"name" dc:"名称" v:"max-length:64#仅支持最大字符长度64"` Description string `json:"description" dc:"描述" v:"max-length:128#仅支持最大字符长度128"` Identifier string `json:"identifier" description:"标识符"` Type int `json:"type" description:"类型:1api、2menu"` }
type SysPermissionInfoListRes ¶
type SysPermissionInfoListRes CollectRes[sys_entity.SysPermission]
type SysPermissionInfoRes ¶
type SysPermissionInfoRes sys_entity.SysPermission
type SysPermissionInfoTreeRes ¶
type SysPermissionInfoTreeRes []*permission.SysPermissionTree
type SysRole ¶
type SysRole struct { Id int64 `p:"id" dc:"ID"` Name string `p:"name" v:"required|length:1,16#请输入角色名称|角色名称长度限定1~16字符" dc:"角色名称"` IsSystem bool `json:"isSystem" description:"是否默认角色,true仅能修改名称,不允许删除和修改"` Description string `p:"description" v:"max-length:128#角色描述长度限定128字符" dc:"角色描述"` UnionMainId int64 `json:"-" dc:"主体id"` }
type SysUser ¶
type SysUser struct { sys_entity.SysUser RoleNames []string `json:"roleNames" dc:"所属角色"` }
type SysUserList ¶ added in v0.2.62
type SysUserList []sys_entity.SysUser
type SysUserListRes ¶
type SysUserListRes CollectRes[SysUser]
type SysUserRegister ¶
type SysUserRegister struct { Username string `json:"username" v:"required|length:4,30#请输入用户名称|用户名称长度非法" dc:"登陆账号"` Password string `json:"password" v:"required|password#请输入密码|密码长度非法" dc:"密码"` ConfirmPassword string `json:"confirmPassword" v:"required|same:password#请输入确认密码|两次密码不一致,请重新输入" dc:"密码"` Captcha string `json:"captcha" v:"required" dc:"验证码"` }
type SysUserRegisterRes ¶
type SysUserRegisterRes struct { UserInfo sys_entity.SysUser `json:"userInfo" dc:"用户信息"` RoleInfoList []sys_entity.SysRole `json:"roleInfoList" dc:"角色信息列表"` }
type TableCacheConf ¶
type TencentAccessToken ¶
type TencentAccessToken struct {
TencentToken TencentToken `json:"response" dc:"token信息"`
}
TencentAccessToken 腾讯平台返回的Token
type TencentOSS ¶
type TencentSdkConf ¶
type TencentSdkConf struct { Identifier string `json:"identifier" v:"required#业务标识符参数错误" dc:"业务标识符,唯一,且不可修改"` Description string `json:"description" dc:"描述"` AppID string `json:"appID" v:"required#请输入 AppID" dc:"AppID"` AESKey string `json:"aesKey" v:"required#请输入 AES Key" dc:"AES Key"` APIKey string `json:"apiKey" v:"required#请输入 API Key" dc:"API Key"` SecretKey string `json:"secretKey" v:"required#请输入 Secret Key" dc:"Secret Key"` Active string `json:"active" v:"required#公共参数" dc:"代表应用接口的值"` Version string `json:"version" v:"required#公共参数" dc:"接口版本"` Region string `json:"region" dc:"代表请求的地域,公共参数"` }
type TencentSdkConfList ¶
type TencentSdkConfList CollectRes[TencentSdkConf]
type TencentSdkConfToken ¶
type TencentSdkConfToken struct { TencentSdkConf TencentAccessToken }
TencentSdkConfToken 配置信息 + Token信息
type TencentToken ¶
type UpdateUserPassword ¶
type UserExtendMap ¶
type UserExtendMap struct {
ClientID string `json:"clientId" dc:"客户端秘钥"`
}
type UserHookFunc ¶ added in v0.2.0
type UserHookFunc HookFunc[sys_enum.UserEvent, sys_entity.SysUser]
type UserHookInfo ¶ added in v0.2.0
type UserHookInfo HookEventType[sys_enum.UserEvent, UserHookFunc]
type UserInnerRegister ¶
type UserInnerRegister struct { Username string `json:"username" v:"required|length:4,30#请输入用户名称|用户名称长度非法" dc:"登陆账号"` Password string `json:"password" v:"required|password#请输入密码|密码长度非法" dc:"密码"` ConfirmPassword string `json:"confirmPassword" v:"required|same:password#请输入确认密码|两次密码不一致,请重新输入" dc:"密码"` RoleIds []int64 `json:"roleIds" dc:"所属角色,多个用逗号隔开"` Mobile string `json:"mobile" dc:"手机号"` }
Source Files ¶
Click to show internal directories.
Click to hide internal directories.