Files
EasyGoAdmin_GoFrame_EleVue/api/v1/category.go
T
2026-10-20 11:37:25 +08:00

99 lines
4.8 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
package v1
import (
"github.com/gogf/gf/v2/util/gmeta"
)
// ============================== 分类模块(树形) ==============================
// CategoryItem 分类行
type CategoryItem struct {
Id int64 `json:"id"` // 主键ID
CategoryName string `json:"categoryName"` // 分类名称
CategoryCode string `json:"categoryCode"` // 分类编码
ParentId int `json:"parentId"` // 上级ID(0=顶级)
Sort int `json:"sort"` // 排序
Note string `json:"note"` // 备注
CreateUser string `json:"createUser"` // 创建人
}
// CategoryPageReq 分类分页请求(平铺)
type CategoryPageReq struct {
gmeta.Meta `method:"get" path:"/api/category/page" summary:"分类分页" permission:"sys:category:page" log:"分类管理-查询分页记录" logType:"query"`
PageReq // 分页基础参数
Keyword string `json:"keyword" dc:"关键词(名称/编码模糊)"` // 关键词
CategoryName string `json:"categoryName" dc:"分类名称模糊"` // 分类名称
CategoryCode string `json:"categoryCode" dc:"分类编码模糊"` // 分类编码
}
// CategoryPageRes 分类分页结果
type CategoryPageRes = PageData[CategoryItem]
// CategoryListReq 分类树形列表请求
type CategoryListReq struct {
gmeta.Meta `method:"get" path:"/api/category/list" summary:"分类树形列表" permission:"sys:category:list" log:"分类管理-查询树形列表" logType:"query"`
Keyword string `json:"keyword" dc:"关键词"` // 关键词
}
// CategoryListRes 分类平铺列表结果
// data 直接为数组,由前端自行构建树形结构
type CategoryListRes = []*CategoryItem
// CategoryDetailReq 分类详情请求
type CategoryDetailReq struct {
gmeta.Meta `method:"get" path:"/api/category/detail/:id" summary:"分类详情" permission:"sys:category:detail" log:"分类管理-查询详情" logType:"query"`
Id int64 `json:"id" v:"required#缺少ID" dc:"分类ID"` // 分类ID
}
// CategoryDetailRes 分类详情结果
type CategoryDetailRes struct {
Id int64 `json:"id"` // 主键ID
CategoryName string `json:"categoryName"` // 分类名称
CategoryCode string `json:"categoryCode"` // 分类编码
ParentId int `json:"parentId"` // 上级ID
Sort int `json:"sort"` // 排序
Note string `json:"note"` // 备注
}
// CategoryAddReq 新增分类请求
type CategoryAddReq struct {
gmeta.Meta `method:"post" path:"/api/category/add" summary:"新增分类" permission:"sys:category:add" log:"分类管理-新增记录" logType:"add"`
CategoryName string `json:"categoryName" v:"required#请输入分类名称" dc:"分类名称"` // 分类名称
CategoryCode string `json:"categoryCode" dc:"分类编码"` // 分类编码
ParentId int `json:"parentId" dc:"上级ID(0=顶级)"` // 上级ID
Sort int `json:"sort" dc:"排序"` // 排序
Note string `json:"note" dc:"备注"` // 备注
}
// CategoryUpdateReq 修改分类请求
type CategoryUpdateReq struct {
gmeta.Meta `method:"put" path:"/api/category/update" summary:"修改分类" permission:"sys:category:update" log:"分类管理-修改记录" logType:"update"`
Id int64 `json:"id" v:"required#缺少ID" dc:"分类ID"` // 分类ID
CategoryName string `json:"categoryName" v:"required#请输入分类名称" dc:"分类名称"` // 分类名称
CategoryCode string `json:"categoryCode" dc:"分类编码"` // 分类编码
ParentId int `json:"parentId" dc:"上级ID"` // 上级ID
Sort int `json:"sort" dc:"排序"` // 排序
Note string `json:"note" dc:"备注"` // 备注
}
// CategoryUpdateRes 修改分类结果
type CategoryUpdateRes struct{}
// CategoryDeleteReq 删除分类请求
type CategoryDeleteReq struct {
gmeta.Meta `method:"delete" path:"/api/category/delete/:id" summary:"删除分类" permission:"sys:category:delete" log:"分类管理-删除记录" logType:"delete"`
Id int64 `json:"id" v:"required#缺少ID" dc:"分类ID"` // 分类ID
}
// CategoryDeleteRes 删除分类结果
type CategoryDeleteRes struct{}
// CategoryBatchDeleteReq 批量删除分类请求
type CategoryBatchDeleteReq struct {
gmeta.Meta `method:"delete" path:"/api/category/batchDelete" summary:"批量删除分类" permission:"sys:category:batchDelete" log:"分类管理-批量删除记录" logType:"delete"`
Ids []int64 `json:"ids" v:"required#请选择要删除的记录" dc:"分类ID列表"` // 分类ID列表
}
// CategoryBatchDeleteRes 批量删除结果
type CategoryBatchDeleteRes struct{}