common

package
v1.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2025 License: LGPL-3.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckAccessAuthReq

type CheckAccessAuthReq struct {
	g.Meta  `path:"/checkAccessAuth" method:"get" summary:"验证接口是否具有访问权限" tags:"公共方法"`
	Address string `p:"address"   description:"接口地址" v:"required#接口地址不能为空"`
}

type CheckAccessAuthRes

type CheckAccessAuthRes struct {
	IsAllow bool `json:"isAllow"`
}

type ConfigAddReq

type ConfigAddReq struct {
	g.Meta         `path:"/config/add" tags:"系统参数管理" method:"post" summary:"添加系统参数"`
	ConfigName     string `p:"configName"  v:"required#参数名称不能为空"`
	ConfigKey      string `p:"configKey"  v:"required#参数键名不能为空"`
	ConfigValue    string `p:"configValue"  v:"required#参数键值不能为空"`
	ConfigType     int    `p:"configType"    v:"required|in:0,1#系统内置不能为空|系统内置类型只能为0或1"`
	ModuleClassify string `p:"moduleClassify" v:"required#字典分类不能为空"`
	Remark         string `p:"remark"`
}

type ConfigAddRes

type ConfigAddRes struct {
}

type ConfigDeleteReq

type ConfigDeleteReq struct {
	g.Meta `path:"/config/delete" tags:"系统参数管理" method:"delete" summary:"删除系统参数"`
	Ids    []int `p:"ids"`
}

type ConfigDeleteRes

type ConfigDeleteRes struct {
}

type ConfigEditReq

type ConfigEditReq struct {
	g.Meta         `path:"/config/edit" tags:"系统参数管理" method:"put" summary:"修改系统参数"`
	ConfigId       int    `p:"configId" v:"required|min:1#主键ID不能为空|主键ID参数错误"`
	ConfigName     string `p:"configName"  v:"required#参数名称不能为空"`
	ConfigKey      string `p:"configKey"  v:"required#参数键名不能为空"`
	ConfigValue    string `p:"configValue"  v:"required#参数键值不能为空"`
	ConfigType     int    `p:"configType"    v:"required|in:0,1#系统内置不能为空|系统内置类型只能为0或1"`
	ModuleClassify string `p:"moduleClassify" v:"required#字典分类不能为空"`
	Remark         string `p:"remark"`
}

type ConfigEditRes

type ConfigEditRes struct {
}

type ConfigGetByKeyReq

type ConfigGetByKeyReq struct {
	g.Meta    `path:"/config/getInfoByKey" tags:"系统参数管理" method:"get" summary:"根据KEY获取系统参数"`
	ConfigKey string `p:"configKey"   description:"参数键名" v:"required#参数键名不能为空"`
}

type ConfigGetByKeyRes

type ConfigGetByKeyRes struct {
	g.Meta `mime:"application/json"`
	Data   *model.SysConfigRes `json:"data"`
}

type ConfigGetByKeysReq

type ConfigGetByKeysReq struct {
	g.Meta    `path:"/config/getInfoByKeys" tags:"系统参数管理" method:"get" summary:"根据KEY数组获取系统参数"`
	ConfigKey []string `p:"configKey"   description:"参数键名" v:"required#参数键名不能为空"`
}

type ConfigGetByKeysRes

type ConfigGetByKeysRes struct {
	g.Meta `mime:"application/json"`
	Data   []*model.SysConfigRes `json:"data"`
}

type ConfigGetReq

type ConfigGetReq struct {
	g.Meta `path:"/config/get" tags:"系统参数管理" method:"get" summary:"获取系统参数"`
	Id     int `p:"id" v:"required#ID不能为空"`
}

type ConfigGetRes

type ConfigGetRes struct {
	g.Meta `mime:"application/json"`
	Data   *model.SysConfigRes `json:"data"`
}

type ConfigSearchReq

type ConfigSearchReq struct {
	g.Meta         `path:"/config/list" tags:"系统参数管理" method:"get" summary:"系统参数列表"`
	ConfigName     string `p:"configName"`     //参数名称
	ConfigKey      string `p:"configKey"`      //参数键名
	ConfigType     string `p:"configType"`     //状态
	ModuleClassify string `p:"moduleClassify"` //字典分类编码
	*PaginationReq
}

type ConfigSearchRes

type ConfigSearchRes struct {
	g.Meta `mime:"application/json"`
	List   []*model.SysConfigRes `json:"list"`
	PaginationRes
}

type DictDataAddReq

type DictDataAddReq struct {
	g.Meta    `path:"/dict/data/add" tags:"字典管理" method:"post" summary:"添加字典数据"`
	DictLabel string `p:"dictLabel"  v:"required#字典标签不能为空"`
	DictValue string `p:"dictValue"  v:"required#字典键值不能为空"`
	DictType  string `p:"dictType"  v:"required#字典类型不能为空"`
	DictSort  int    `p:"dictSort"  v:"integer#排序只能为整数"`
	CssClass  string `p:"cssClass"`
	ListClass string `p:"listClass"`
	IsDefault int    `p:"isDefault" v:"required|in:0,1#系统默认不能为空|默认值只能为0或1"`
	Status    int    `p:"status"    v:"required|in:0,1#状态不能为空|状态只能为0或1"`
	Remark    string `p:"remark"`
}

type DictDataAddRes

type DictDataAddRes struct {
}

type DictDataDeleteReq

type DictDataDeleteReq struct {
	g.Meta `path:"/dict/data/delete" tags:"字典管理" method:"delete" summary:"删除字典数据"`
	Ids    []int `p:"ids"`
}

type DictDataDeleteRes

type DictDataDeleteRes struct {
}

type DictDataEditReq

type DictDataEditReq struct {
	g.Meta    `path:"/dict/data/edit" tags:"字典管理" method:"put" summary:"修改字典数据"`
	DictCode  int    `p:"dictCode" v:"required|min:1#主键ID不能为空|主键ID不能小于1"`
	DictLabel string `p:"dictLabel"  v:"required#字典标签不能为空"`
	DictValue string `p:"dictValue"  v:"required#字典键值不能为空"`
	DictType  string `p:"dictType"  v:"required#字典类型不能为空"`
	DictSort  int    `p:"dictSort"  v:"integer#排序只能为整数"`
	CssClass  string `p:"cssClass"`
	ListClass string `p:"listClass"`
	IsDefault int    `p:"isDefault" v:"required|in:0,1#系统默认不能为空|默认值只能为0或1"`
	Status    int    `p:"status"    v:"required|in:0,1#状态不能为空|状态只能为0或1"`
	Remark    string `p:"remark"`
}

type DictDataEditRes

type DictDataEditRes struct {
}

type DictDataGetReq

type DictDataGetReq struct {
	g.Meta   `path:"/dict/data/get" tags:"字典管理" method:"get" summary:"获取字典数据"`
	DictCode uint `p:"dictCode"`
}

type DictDataGetRes

type DictDataGetRes struct {
	g.Meta `mime:"application/json"`
	Dict   *model.SysDictDataRes `json:"dict"`
}

type DictDataSearchReq

type DictDataSearchReq struct {
	g.Meta    `path:"/dict/data/list" tags:"字典管理" method:"get" summary:"字典数据列表"`
	DictType  string `p:"dictType"`  //字典类型
	DictLabel string `p:"dictLabel"` //字典标签
	Status    string `p:"status"`    //状态
	PaginationReq
}

DictDataSearchReq 分页请求参数

type DictDataSearchRes

type DictDataSearchRes struct {
	g.Meta `mime:"application/json"`
	List   []*model.SysDictDataRes `json:"list"`
	PaginationRes
}

DictDataSearchRes 字典数据结果

type DictTypeAddReq

type DictTypeAddReq struct {
	g.Meta         `path:"/dict/type/add" tags:"字典管理" method:"post" summary:"添加字典类型"`
	DictName       string `p:"dictName"  v:"required#字典名称不能为空"`
	DictType       string `p:"dictType"  v:"required#字典类型不能为空"`
	Status         uint   `p:"status"  v:"required|in:0,1#状态不能为空|状态只能为0或1"`
	ModuleClassify string `p:"moduleClassify"` //模块分类
	Remark         string `p:"remark"`
}

type DictTypeAddRes

type DictTypeAddRes struct {
}

type DictTypeDeleteReq

type DictTypeDeleteReq struct {
	g.Meta  `path:"/dict/type/delete" tags:"字典管理" method:"delete" summary:"删除字典类型"`
	DictIds []int `p:"dictIds" v:"required#字典类型id不能为空"`
}

type DictTypeDeleteRes

type DictTypeDeleteRes struct {
}

type DictTypeEditReq

type DictTypeEditReq struct {
	g.Meta         `path:"/dict/type/edit" tags:"字典管理" method:"put" summary:"修改字典类型"`
	DictId         int    `p:"dictId" v:"required|min:1#主键ID不能为空|主键ID必须为大于0的值"`
	DictName       string `p:"dictName"  v:"required#字典名称不能为空"`
	DictType       string `p:"dictType"  v:"required#字典类型不能为空"`
	Status         uint   `p:"status"  v:"required|in:0,1#状态不能为空|状态只能为0或1"`
	ModuleClassify string `p:"moduleClassify"` //模块分类
	Remark         string `p:"remark"`
}

type DictTypeEditRes

type DictTypeEditRes struct {
}

type DictTypeGetReq

type DictTypeGetReq struct {
	g.Meta `path:"/dict/type/get" tags:"字典管理" method:"get" summary:"获取字典类型"`
	DictId uint `p:"dictId" v:"required#类型id不能为空"`
}

type DictTypeGetRes

type DictTypeGetRes struct {
	g.Meta   `mime:"application/json"`
	DictType *model.SysDictTypeRes `json:"dictType"`
}

type DictTypeSearchReq

type DictTypeSearchReq struct {
	g.Meta         `path:"/dict/type/list" tags:"字典管理" method:"get" summary:"字典类型列表"`
	DictName       string `p:"dictName"`       //字典名称
	DictType       string `p:"dictType"`       //字典类型
	Status         string `p:"status"`         //字典状态
	ModuleClassify string `p:"moduleClassify"` //模块分类
	*PaginationReq
}

type DictTypeSearchRes

type DictTypeSearchRes struct {
	g.Meta       `mime:"application/json"`
	DictTypeList []*model.SysDictTypeInfoRes `json:"dictTypeList"`
	PaginationRes
}

type EditSysConfigSettingReq

type EditSysConfigSettingReq struct {
	g.Meta     `path:"/editSysConfigSetting" method:"put" summary:"修改系统配置" tags:"系统参数管理"`
	ConfigInfo []*model.EditConfigReq
}

type EditSysConfigSettingRes

type EditSysConfigSettingRes struct {
}

type GetDictReq

type GetDictReq struct {
	g.Meta        `path:"/dict/data/getDictData" tags:"字典管理" method:"get" summary:"获取字典数据公共方法"`
	Authorization string `p:"Authorization" in:"header" dc:"Bearer {{token}}"`
	DictType      string `p:"dictType" v:"required#字典类型不能为空"`
	DefaultValue  string `p:"defaultValue"`
}

GetDictReq 获取字典信息请求参数

type GetDictRes

type GetDictRes struct {
	g.Meta `mime:"application/json"`
	Data   *model.DictTypeRes   `json:"info"`
	Values []*model.DictDataRes `json:"values"`
}

GetDictRes 完整的一个字典信息

type GetNotice2Req

type GetNotice2Req struct {
	g.Meta `path:"/notice/data2" tags:"公共方法" method:"get" summary:"获取实时通知信息"`
	Topic  string `p:"topic" v:"required#订阅主题不能为空"`
}

type GetNotice2Res

type GetNotice2Res struct {
	g.Meta `mime:"application/json"`
}

type GetNoticeReq

type GetNoticeReq struct {
	g.Meta `path:"/notice/data" tags:"公共方法" method:"get" summary:"获取实时通知信息"`
	Topic  string `p:"topic" v:"required#订阅主题不能为空"`
}

type GetNoticeRes

type GetNoticeRes struct {
	g.Meta `mime:"application/json"`
}

type GetSysConfigSettingReq

type GetSysConfigSettingReq struct {
	g.Meta `path:"/getSysConfigSetting" method:"get" summary:"获取系统配置" tags:"系统参数管理"`
	Types  int `p:"types"   description:"类型  0 基础配置 1 安全配置"`
}

type GetSysConfigSettingRes

type GetSysConfigSettingRes struct {
	Info []*model.SysConfigRes `json:"data"`
}

type GetSysInfoReq

type GetSysInfoReq struct {
	g.Meta `path:"/sysinfo" tags:"公共方法" method:"get" summary:"获取系统相关的信息"`
}

type GetSysInfoRes

type GetSysInfoRes g.Map

type IsTokenReq

type IsTokenReq struct {
	g.Meta `path:"/isToken" method:"get" summary:"验证token是否正确" tags:"公共方法"`
}

type IsTokenRes

type IsTokenRes struct {
	ExpiresAt int64  `json:"expiresAt"`
	IsToken   bool   `json:"isToken"`
	Auth      string `json:"auth"`
}

type PaginationReq

type PaginationReq struct {
	Param          map[string]interface{} `json:"param" dc:"搜索字段参数,写法param[字段名称]"`
	KeyWord        string                 `json:"keyWord" dc:"搜索关键字"`
	Year           string                 `json:"year" dc:"年份,如:2024"`
	DateRange      []string               `json:"dateRange" dc:"日期范围,数组"`
	Accurate       string                 `json:"accurate" dc:"数据精确类型(m:月,d:天,h:小时)"`
	AccurateRanges string                 ``                         /* 150-byte string literal not displayed */
	OrderBy        string                 `json:"orderBy" dc:"排序方式"` //排序方式
	PageNum        int                    `json:"pageNum" in:"query" d:"1"  v:"min:0#分页号码错误"     dc:"分页号码,默认1"`
	PageSize       int                    `json:"PageSize" in:"query" d:"10" v:"max:500#分页数量最大500条" dc:"分页数量,最大500"`
}

type PaginationRes

type PaginationRes struct {
	CurrentPage int `json:"currentPage" dc:"当前页"`
	Total       int `dc:"总数"`
}

type UploadMultipleFileReq

type UploadMultipleFileReq struct {
	g.Meta `path:"/multipleFile" tags:"文件上传下载" method:"post" summary:"上传多文件"`
	Source int `json:"source" dc:"本地-0、腾讯云-1、阿里云-2、七牛云-3、MinIO-4"`
}

type UploadMultipleImgReq

type UploadMultipleImgReq struct {
	g.Meta `path:"/multipleImg" tags:"文件上传下载" method:"post" summary:"上传多图片"`
	Source int `json:"source" dc:"本地-0、腾讯云-1、阿里云-2、七牛云-3、MinIO-4"`
}

type UploadMultipleRes

type UploadMultipleRes []*UploadResponse

type UploadResponse

type UploadResponse struct {
	Size     int64  `json:"size"`
	Path     string `json:"path"`
	FullPath string `json:"full_path"`
	Name     string `json:"name"`
	Type     string `json:"type"`
}

type UploadSingleFileReq

type UploadSingleFileReq struct {
	g.Meta `path:"/singleFile" tags:"文件上传下载" method:"post" summary:"上传文件"`
	Source int `json:"source" dc:"本地-0、腾讯云-1、阿里云-2、七牛云-3、MinIO-4"`
}

type UploadSingleImgReq

type UploadSingleImgReq struct {
	g.Meta `path:"/singleImg" tags:"文件上传下载" method:"post" summary:"上传图片"`
	Source int `json:"source" dc:"本地-0、腾讯云-1、阿里云-2、七牛云-3、MinIO-4"`
}

type UploadSingleRes

type UploadSingleRes struct {
	g.Meta `mime:"application/json"`
	UploadResponse
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL