126 lines
7.7 KiB
Go
126 lines
7.7 KiB
Go
package v1
|
||
|
||
import (
|
||
"github.com/gogf/gf/v2/util/gmeta"
|
||
)
|
||
|
||
// ============================== 配置项模块 ==============================
|
||
|
||
// ConfigItemItem 配置项行数据
|
||
// 用于配置项分页列表、配置项列表等场景的配置项基础信息
|
||
type ConfigItemItem struct {
|
||
Id int64 `json:"id"` // 主键ID
|
||
ConfigId int64 `json:"configId"` // 所属配置ID
|
||
ConfigName string `json:"configName"` // 所属配置名称
|
||
Name string `json:"name"` // 配置项名称
|
||
Code string `json:"code"` // 配置项编码
|
||
Value string `json:"value"` // 配置项值
|
||
Options string `json:"options"` // 可选项（JSON）
|
||
Type string `json:"type"` // 控件类型
|
||
Status int `json:"status"` // 状态
|
||
StatusText string `json:"statusText"` // 状态文本
|
||
Sort int `json:"sort"` // 排序
|
||
Note string `json:"note"` // 备注
|
||
CreateUser string `json:"createUser"` // 创建人
|
||
}
|
||
|
||
// ConfigItemPageReq 配置项分页请求
|
||
// 支持关键词、配置项名称、所属配置及状态等条件组合查询
|
||
type ConfigItemPageReq struct {
|
||
gmeta.Meta `method:"get" path:"/api/config/item/page" summary:"配置项分页" permission:"sys:configitem:page" log:"配置项管理-查询分页记录" logType:"query"`
|
||
PageReq // 分页基础参数
|
||
Keyword string `json:"keyword" dc:"关键词（名称/编码模糊）"` // 关键词，名称或编码模糊匹配
|
||
Name string `json:"name" dc:"配置项名称模糊"` // 配置项名称模糊匹配
|
||
ConfigId int64 `json:"configId" dc:"所属配置ID"` // 所属配置ID
|
||
Status int `json:"status" dc:"状态"` // 状态
|
||
}
|
||
|
||
// ConfigItemPageRes 配置项分页结果
|
||
type ConfigItemPageRes = PageData[ConfigItemItem]
|
||
|
||
// ConfigItemListReq 配置项列表请求
|
||
// 按所属配置、状态等条件查询配置项集合
|
||
type ConfigItemListReq struct {
|
||
gmeta.Meta `method:"get" path:"/api/config/item/list" summary:"配置项列表" permission:"sys:configitem:list" log:"配置项管理-查询列表" logType:"query"`
|
||
Keyword string `json:"keyword" dc:"关键词"` // 关键词
|
||
ConfigId int64 `json:"configId" dc:"所属配置ID"` // 所属配置ID
|
||
Status int `json:"status" dc:"状态"` // 状态
|
||
}
|
||
|
||
// ConfigItemListRes 配置项列表结果
|
||
type ConfigItemListRes = []ConfigItemItem
|
||
|
||
// ConfigItemDetailReq 配置项详情请求
|
||
type ConfigItemDetailReq struct {
|
||
gmeta.Meta `method:"get" path:"/api/config/item/detail/:id" summary:"配置项详情" permission:"sys:configitem:detail" log:"配置项管理-查询详情" logType:"query"`
|
||
Id int64 `json:"id" v:"required#缺少ID" dc:"配置项ID"` // 配置项ID
|
||
}
|
||
|
||
// ConfigItemDetailRes 配置项详情结果
|
||
// 包含配置项基础信息、所属配置编码及多值类型拆分后的值列表
|
||
type ConfigItemDetailRes struct {
|
||
Id int64 `json:"id"` // 主键ID
|
||
ConfigId int64 `json:"configId"` // 所属配置ID
|
||
ConfigCode string `json:"configCode"` // 所属配置编码
|
||
Name string `json:"name"` // 配置项名称
|
||
Code string `json:"code"` // 配置项编码
|
||
Value string `json:"value"` // 配置项值
|
||
ValueList []string `json:"valueList"` // 值列表，多值类型使用
|
||
Options string `json:"options"` // 可选项（JSON）
|
||
Type string `json:"type"` // 控件类型
|
||
Status int `json:"status"` // 状态
|
||
StatusText string `json:"statusText"` // 状态文本
|
||
Sort int `json:"sort"` // 排序
|
||
Note string `json:"note"` // 备注
|
||
}
|
||
|
||
// ConfigItemAddReq 新增配置项请求
|
||
type ConfigItemAddReq struct {
|
||
gmeta.Meta `method:"post" path:"/api/config/item/add" summary:"新增配置项" permission:"sys:configitem:add" log:"配置项管理-新增记录" logType:"add"`
|
||
ConfigId int64 `json:"configId" v:"required#请选择所属配置" dc:"所属配置ID"` // 所属配置ID
|
||
Name string `json:"name" v:"required#请输入配置项名称" dc:"配置项名称"` // 配置项名称
|
||
Code string `json:"code" v:"required#请输入配置项编码" dc:"配置项编码"` // 配置项编码
|
||
Value string `json:"value" dc:"配置项值"` // 配置项值
|
||
Options string `json:"options" dc:"可选项（JSON）"` // 可选项
|
||
Type string `json:"type" dc:"类型：text-单行文本 textarea-多行文本 number-数字 select-下拉 radio-单选 checkbox-复选 image-单图 images-多图 file-单文件 files-多文件（见字典 config_item_type）"` // 控件类型
|
||
Status int `json:"status" dc:"状态"` // 状态
|
||
Sort int `json:"sort" dc:"排序"` // 排序
|
||
Note string `json:"note" dc:"备注"` // 备注
|
||
}
|
||
|
||
// ConfigItemUpdateReq 修改配置项请求
|
||
type ConfigItemUpdateReq struct {
|
||
gmeta.Meta `method:"put" path:"/api/config/item/update" summary:"修改配置项" permission:"sys:configitem:update" log:"配置项管理-修改记录" logType:"update"`
|
||
Id int64 `json:"id" v:"required#缺少ID" dc:"配置项ID"` // 配置项ID
|
||
ConfigId int64 `json:"configId" dc:"所属配置ID"` // 所属配置ID
|
||
Name string `json:"name" v:"required#请输入配置项名称" dc:"配置项名称"` // 配置项名称
|
||
Code string `json:"code" v:"required#请输入配置项编码" dc:"配置项编码"` // 配置项编码
|
||
Value string `json:"value" dc:"配置项值"` // 配置项值
|
||
Options string `json:"options" dc:"可选项（JSON）"` // 可选项
|
||
Type string `json:"type" dc:"类型（见字典 config_item_type）"` // 控件类型
|
||
Status int `json:"status" dc:"状态"` // 状态
|
||
Sort int `json:"sort" dc:"排序"` // 排序
|
||
Note string `json:"note" dc:"备注"` // 备注
|
||
}
|
||
|
||
// ConfigItemUpdateRes 修改配置项结果
|
||
type ConfigItemUpdateRes struct{}
|
||
|
||
// ConfigItemDeleteReq 删除配置项请求
|
||
type ConfigItemDeleteReq struct {
|
||
gmeta.Meta `method:"delete" path:"/api/config/item/delete/:id" summary:"删除配置项" permission:"sys:configitem:delete" log:"配置项管理-删除记录" logType:"delete"`
|
||
Id int64 `json:"id" v:"required#缺少ID" dc:"配置项ID"` // 配置项ID
|
||
}
|
||
|
||
// ConfigItemDeleteRes 删除配置项结果
|
||
type ConfigItemDeleteRes struct{}
|
||
|
||
// ConfigItemBatchDeleteReq 批量删除配置项请求
|
||
type ConfigItemBatchDeleteReq struct {
|
||
gmeta.Meta `method:"delete" path:"/api/config/item/batchDelete" summary:"批量删除配置项" permission:"sys:configitem:batchDelete" log:"配置项管理-批量删除记录" logType:"delete"`
|
||
Ids []int64 `json:"ids" v:"required#请选择要删除的记录" dc:"配置项ID列表"` // 配置项ID列表
|
||
}
|
||
|
||
// ConfigItemBatchDeleteRes 批量删除结果
|
||
type ConfigItemBatchDeleteRes struct{}
|