167 lines
11 KiB
Go
167 lines
11 KiB
Go
// +======================================================================
|
||
// | EasyGoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
// +----------------------------------------------------------------------
|
||
// | Copyright (c) 2019-2026 半城风雨团队 版权所有
|
||
// +----------------------------------------------------------------------
|
||
// | 开源协议: Apache-2.0
|
||
// | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
// +----------------------------------------------------------------------
|
||
// | 官方网站: https://www.easygoadmin.vip
|
||
// +----------------------------------------------------------------------
|
||
// | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
// +======================================================================
|
||
// | 版权和免责声明:
|
||
// | 一、知识产权声明
|
||
// | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||
// | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||
// | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||
// | 二、使用限制与禁止条款
|
||
// | 您理解并同意，禁止将本产品用于以下任何行为：
|
||
// | 1. 任何违反中华人民共和国法律法规的用途；
|
||
// | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||
// | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||
// | 三、责任豁免
|
||
// | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||
// | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||
// | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||
// | 四、违约与法律责任
|
||
// | 如发现任何违反本声明的行为，本团队有权：
|
||
// | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||
// | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||
// | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||
// | 五、许可范围说明
|
||
// | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||
// | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||
// | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||
// | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||
// | 成的一切经济损失及商誉损害。
|
||
// | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||
// | 许可协议》附件为准。
|
||
// +======================================================================
|
||
|
||
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{}
|