Files
2026-10-20 19:07:36 +08:00

156 lines
8.7 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"
)
// ============================== 参数模块 ==============================
// ParamItem 参数行数据
// 用于参数分页列表、参数列表等场景的参数基础信息
type ParamItem struct {
Id int64 `json:"id"` // 主键ID
Name string `json:"name"` // 参数名称
Code string `json:"code"` // 参数编码
Value string `json:"value"` // 参数值
Type int `json:"type"` // 类型:1-文本 2-数字 3-开关
TypeText string `json:"typeText"` // 类型文本
Status int `json:"status"` // 状态
StatusText string `json:"statusText"` // 状态文本
Sort int `json:"sort"` // 排序
Note string `json:"note"` // 备注
CreateUser string `json:"createUser"` // 创建人
}
// ParamPageReq 参数分页请求
// 支持关键词、参数名称、类型、状态等条件组合查询
type ParamPageReq struct {
gmeta.Meta `method:"get" path:"/api/param/page" summary:"参数分页" permission:"sys:param:page" log:"参数管理-查询分页记录" logType:"query"`
PageReq // 分页基础参数
Keyword string `json:"keyword" dc:"关键词(名称/编码模糊)"` // 关键词,名称或编码模糊匹配
Name string `json:"name" dc:"参数名称模糊"` // 参数名称模糊匹配
Type int `json:"type" dc:"类型:1-文本 2-数字 3-开关"` // 类型
Status int `json:"status" dc:"状态"` // 状态
}
// ParamPageRes 参数分页结果
type ParamPageRes = PageData[ParamItem]
// ParamListReq 参数列表请求
type ParamListReq struct {
gmeta.Meta `method:"get" path:"/api/param/list" summary:"参数列表" permission:"sys:param:list" log:"参数管理-查询列表" logType:"query"`
Keyword string `json:"keyword" dc:"关键词"` // 关键词
Type int `json:"type" dc:"类型"` // 类型
Status int `json:"status" dc:"状态"` // 状态
}
// ParamListRes 参数列表结果
type ParamListRes = []ParamItem
// ParamDetailReq 参数详情请求
type ParamDetailReq struct {
gmeta.Meta `method:"get" path:"/api/param/detail/:id" summary:"参数详情" permission:"sys:param:detail" log:"参数管理-查询详情" logType:"query"`
Id int64 `json:"id" v:"required#缺少ID" dc:"参数ID"` // 参数ID
}
// ParamDetailRes 参数详情结果
type ParamDetailRes struct {
Id int64 `json:"id"` // 主键ID
Name string `json:"name"` // 参数名称
Code string `json:"code"` // 参数编码
Value string `json:"value"` // 参数值
Type int `json:"type"` // 类型:1-文本 2-数字 3-开关
TypeText string `json:"typeText"` // 类型文本
Status int `json:"status"` // 状态
StatusText string `json:"statusText"` // 状态文本
Sort int `json:"sort"` // 排序
Note string `json:"note"` // 备注
}
// ParamAddReq 新增参数请求
type ParamAddReq struct {
gmeta.Meta `method:"post" path:"/api/param/add" summary:"新增参数" permission:"sys:param:add" log:"参数管理-新增记录" logType:"add"`
Name string `json:"name" v:"required#请输入参数名称" dc:"参数名称"` // 参数名称
Code string `json:"code" v:"required#请输入参数编码" dc:"参数编码"` // 参数编码
Value string `json:"value" dc:"参数值"` // 参数值
Type int `json:"type" dc:"类型:1-文本 2-数字 3-开关"` // 类型
Status int `json:"status" dc:"状态"` // 状态
Sort int `json:"sort" dc:"排序"` // 排序
Note string `json:"note" dc:"备注"` // 备注
}
// ParamUpdateReq 修改参数请求
type ParamUpdateReq struct {
gmeta.Meta `method:"put" path:"/api/param/update" summary:"修改参数" permission:"sys:param:update" log:"参数管理-修改记录" logType:"update"`
Id int64 `json:"id" v:"required#缺少ID" dc:"参数ID"` // 参数ID
Name string `json:"name" v:"required#请输入参数名称" dc:"参数名称"` // 参数名称
Code string `json:"code" v:"required#请输入参数编码" dc:"参数编码"` // 参数编码
Value string `json:"value" dc:"参数值"` // 参数值
Type int `json:"type" dc:"类型"` // 类型
Status int `json:"status" dc:"状态"` // 状态
Sort int `json:"sort" dc:"排序"` // 排序
Note string `json:"note" dc:"备注"` // 备注
}
// ParamUpdateRes 修改参数结果
type ParamUpdateRes struct{}
// ParamDeleteReq 删除参数请求
type ParamDeleteReq struct {
gmeta.Meta `method:"delete" path:"/api/param/delete/:id" summary:"删除参数" permission:"sys:param:delete" log:"参数管理-删除记录" logType:"delete"`
Id int64 `json:"id" v:"required#缺少ID" dc:"参数ID"` // 参数ID
}
// ParamDeleteRes 删除参数结果
type ParamDeleteRes struct{}
// ParamBatchDeleteReq 批量删除参数请求
type ParamBatchDeleteReq struct {
gmeta.Meta `method:"delete" path:"/api/param/batchDelete" summary:"批量删除参数" permission:"sys:param:batchDelete" log:"参数管理-批量删除记录" logType:"delete"`
Ids []int64 `json:"ids" v:"required#请选择要删除的记录" dc:"参数ID列表"` // 参数ID列表
}
// ParamBatchDeleteRes 批量删除结果
type ParamBatchDeleteRes struct{}