117 lines
5.8 KiB
Go
117 lines
5.8 KiB
Go
package v1
|
|
|
|
import (
|
|
"github.com/gogf/gf/v2/os/gtime"
|
|
"github.com/gogf/gf/v2/util/gmeta"
|
|
)
|
|
|
|
// ============================== 文件模板模块 ==============================
|
|
|
|
// FileTemplateItem 文件模板行数据
|
|
// 用于文件模板分页列表、文件模板列表等场景的模板基础信息
|
|
type FileTemplateItem struct {
|
|
Id int64 `json:"id"` // 主键ID
|
|
Name string `json:"name"` // 模板名称
|
|
Code string `json:"code"` // 模板编码
|
|
FileName string `json:"fileName"` // 文件名
|
|
FilePath string `json:"filePath"` // 文件路径
|
|
Note string `json:"note"` // 备注
|
|
Sort int `json:"sort"` // 排序
|
|
CreateUser string `json:"createUser"` // 创建人
|
|
CreateTime *gtime.Time `json:"createTime"` // 创建时间
|
|
}
|
|
|
|
// FileTemplatePageReq 文件模板分页请求
|
|
// 支持关键词、模板名称等条件组合查询
|
|
type FileTemplatePageReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/file/template/page" summary:"文件模板分页" permission:"sys:fileTemplate:page" log:"文件模板-查询分页记录" logType:"query"`
|
|
PageReq // 分页基础参数
|
|
Keyword string `json:"keyword" dc:"关键词（名称/编码模糊）"` // 关键词，名称或编码模糊匹配
|
|
Name string `json:"name" dc:"模板名称模糊"` // 模板名称模糊匹配
|
|
}
|
|
|
|
// FileTemplatePageRes 文件模板分页结果
|
|
type FileTemplatePageRes = PageData[FileTemplateItem]
|
|
|
|
// FileTemplateListReq 文件模板列表请求
|
|
type FileTemplateListReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/file/template/list" summary:"文件模板列表" permission:"sys:fileTemplate:list" log:"文件模板-查询列表" logType:"query"`
|
|
Keyword string `json:"keyword" dc:"关键词"` // 关键词
|
|
}
|
|
|
|
// FileTemplateListRes 文件模板列表结果
|
|
type FileTemplateListRes = []FileTemplateItem
|
|
|
|
// FileTemplateDetailReq 文件模板详情请求
|
|
type FileTemplateDetailReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/file/template/detail/:id" summary:"文件模板详情" permission:"sys:fileTemplate:detail" log:"文件模板-查询详情" logType:"query"`
|
|
Id int64 `json:"id" v:"required#缺少ID" dc:"模板ID"` // 模板ID
|
|
}
|
|
|
|
// FileTemplateDetailRes 文件模板详情结果
|
|
type FileTemplateDetailRes struct {
|
|
Id int64 `json:"id"` // 主键ID
|
|
Name string `json:"name"` // 模板名称
|
|
Code string `json:"code"` // 模板编码
|
|
FileName string `json:"fileName"` // 文件名
|
|
FilePath string `json:"filePath"` // 文件路径
|
|
Note string `json:"note"` // 备注
|
|
Sort int `json:"sort"` // 排序
|
|
}
|
|
|
|
// FileTemplateAddReq 新增文件模板请求
|
|
type FileTemplateAddReq struct {
|
|
gmeta.Meta `method:"post" path:"/api/file/template/add" summary:"新增文件模板" permission:"sys:fileTemplate:add" log:"文件模板-新增记录" logType:"add"`
|
|
Name string `json:"name" v:"required#请输入模板名称" dc:"模板名称"` // 模板名称
|
|
Code string `json:"code" v:"required#请输入模板编码" dc:"模板编码"` // 模板编码
|
|
FileName string `json:"fileName" dc:"文件名"` // 文件名
|
|
FilePath string `json:"filePath" dc:"文件路径"` // 文件路径
|
|
Note string `json:"note" dc:"备注"` // 备注
|
|
Sort int `json:"sort" dc:"排序"` // 排序
|
|
}
|
|
|
|
// FileTemplateUpdateReq 修改文件模板请求
|
|
type FileTemplateUpdateReq struct {
|
|
gmeta.Meta `method:"put" path:"/api/file/template/update" summary:"修改文件模板" permission:"sys:fileTemplate: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:"模板编码"` // 模板编码
|
|
FileName string `json:"fileName" dc:"文件名"` // 文件名
|
|
FilePath string `json:"filePath" dc:"文件路径"` // 文件路径
|
|
Note string `json:"note" dc:"备注"` // 备注
|
|
Sort int `json:"sort" dc:"排序"` // 排序
|
|
}
|
|
|
|
// FileTemplateUpdateRes 修改文件模板结果
|
|
type FileTemplateUpdateRes struct{}
|
|
|
|
// FileTemplateDeleteReq 删除文件模板请求
|
|
type FileTemplateDeleteReq struct {
|
|
gmeta.Meta `method:"delete" path:"/api/file/template/delete/:id" summary:"删除文件模板" permission:"sys:fileTemplate:delete" log:"文件模板-删除记录" logType:"delete"`
|
|
Id int64 `json:"id" v:"required#缺少ID" dc:"模板ID"` // 模板ID
|
|
}
|
|
|
|
// FileTemplateDeleteRes 删除文件模板结果
|
|
type FileTemplateDeleteRes struct{}
|
|
|
|
// FileTemplateBatchDeleteReq 批量删除文件模板请求
|
|
type FileTemplateBatchDeleteReq struct {
|
|
gmeta.Meta `method:"delete" path:"/api/file/template/batchDelete" summary:"批量删除文件模板" permission:"sys:fileTemplate:batchDelete" log:"文件模板-批量删除记录" logType:"delete"`
|
|
Ids []int64 `json:"ids" v:"required#请选择要删除的记录" dc:"模板ID列表"` // 模板ID列表
|
|
}
|
|
|
|
// FileTemplateBatchDeleteRes 批量删除结果
|
|
type FileTemplateBatchDeleteRes struct{}
|
|
|
|
// FileTemplateByCodeReq 按编码查询模板请求
|
|
// 登录用户即可访问，按模板编码查询模板详情
|
|
type FileTemplateByCodeReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/file/template/getTemplateByCode/:code" summary:"按编码查询模板" log:"文件模板-查询模板详情" logType:"query"`
|
|
Code string `json:"code" v:"required#请输入模板编码" dc:"模板编码"` // 模板编码
|
|
}
|
|
|
|
// FileTemplateByCodeRes 按编码查询模板结果
|
|
type FileTemplateByCodeRes struct {
|
|
FileTemplateItem
|
|
}
|