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

144 lines
7.0 KiB
Go

package v1
import (
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/util/gmeta"
)
// ============================== 文章模块 ==============================
// ArticleItem 文章行
type ArticleItem struct {
Id int64 `json:"id"` // 主键ID
CategoryId int `json:"categoryId"` // 分类ID
CategoryName string `json:"categoryName"` // 分类名称
Title string `json:"title"` // 标题
Cover string `json:"cover"` // 封面图
Intro string `json:"intro"` // 简介
Author string `json:"author"` // 作者
Status int `json:"status"` // 状态:0-草稿 1-发布
StatusText string `json:"statusText"` // 状态文本
Click int `json:"click"` // 点击量
Sort int `json:"sort"` // 排序
CreateUser string `json:"createUser"` // 创建人
CreateTime *gtime.Time `json:"createTime"` // 创建时间
}
// ArticlePageReq 文章分页请求
type ArticlePageReq struct {
gmeta.Meta `method:"get" path:"/api/article/page" summary:"文章分页" permission:"sys:article:page" log:"文章管理-查询分页记录" logType:"query"`
PageReq // 分页基础参数
Keyword string `json:"keyword" dc:"关键词(标题/作者模糊)"` // 关键词
Title string `json:"title" dc:"标题模糊"` // 标题
CategoryId int `json:"categoryId" dc:"分类ID"` // 分类ID
Status int `json:"status" dc:"状态:0-草稿 1-发布"` // 状态
}
// ArticlePageRes 文章分页结果
type ArticlePageRes = PageData[ArticleItem]
// ArticleListReq 文章列表请求(下拉/最新)
type ArticleListReq struct {
gmeta.Meta `method:"get" path:"/api/article/list" summary:"文章列表" permission:"sys:article:list" log:"文章管理-查询列表" logType:"query"`
Keyword string `json:"keyword" dc:"关键词"` // 关键词
CategoryId int `json:"categoryId" dc:"分类ID"` // 分类ID
Status int `json:"status" dc:"状态"` // 状态
Limit int `json:"limit" dc:"条数上限"` // 条数上限
}
// ArticleListItem 文章列表行(精简)
type ArticleListItem struct {
Id int64 `json:"id"` // 主键ID
Title string `json:"title"` // 标题
Status int `json:"status"` // 状态:0-草稿 1-发布
Sort int `json:"sort"` // 排序
}
// ArticleListRes 文章列表结果
type ArticleListRes = []ArticleListItem
// ArticleDetailReq 文章详情请求
type ArticleDetailReq struct {
gmeta.Meta `method:"get" path:"/api/article/detail/:id" summary:"文章详情" permission:"sys:article:detail" log:"文章管理-查询详情" logType:"query"`
Id int64 `json:"id" v:"required#缺少ID" dc:"文章ID"` // 文章ID
}
// ArticleDetailRes 文章详情结果
type ArticleDetailRes struct {
Id int64 `json:"id"` // 主键ID
CategoryId int `json:"categoryId"` // 分类ID
Title string `json:"title"` // 标题
Cover string `json:"cover"` // 封面图
Images string `json:"images"` // 多图(逗号分隔)
ImagesList []string `json:"imagesList"` // 多图列表
Intro string `json:"intro"` // 简介
Content string `json:"content"` // 正文
Author string `json:"author"` // 作者
Status int `json:"status"` // 状态:0-草稿 1-发布
StatusText string `json:"statusText"` // 状态文本
Click int `json:"click"` // 点击量
Sort int `json:"sort"` // 排序
CreateTime *gtime.Time `json:"createTime"` // 创建时间
}
// ArticleAddReq 新增文章请求
type ArticleAddReq struct {
gmeta.Meta `method:"post" path:"/api/article/add" summary:"新增文章" permission:"sys:article:add" log:"文章管理-新增记录" logType:"add"`
CategoryId int `json:"categoryId" dc:"分类ID"` // 分类ID
Title string `json:"title" v:"required#请输入标题" dc:"标题"` // 标题
Cover string `json:"cover" dc:"封面图"` // 封面图
Images string `json:"images" dc:"多图(逗号分隔)"` // 多图
Intro string `json:"intro" dc:"简介"` // 简介
Content string `json:"content" dc:"正文"` // 正文
Author string `json:"author" dc:"作者"` // 作者
Status int `json:"status" dc:"状态:0-草稿 1-发布"` // 状态
Sort int `json:"sort" dc:"排序"` // 排序
}
// ArticleUpdateReq 修改文章请求
type ArticleUpdateReq struct {
gmeta.Meta `method:"put" path:"/api/article/update" summary:"修改文章" permission:"sys:article:update" log:"文章管理-修改记录" logType:"update"`
Id int64 `json:"id" v:"required#缺少ID" dc:"文章ID"` // 文章ID
CategoryId int `json:"categoryId" dc:"分类ID"` // 分类ID
Title string `json:"title" v:"required#请输入标题" dc:"标题"` // 标题
Cover string `json:"cover" dc:"封面图"` // 封面图
Images string `json:"images" dc:"多图"` // 多图
Intro string `json:"intro" dc:"简介"` // 简介
Content string `json:"content" dc:"正文"` // 正文
Author string `json:"author" dc:"作者"` // 作者
Status int `json:"status" dc:"状态"` // 状态
Click int `json:"click" dc:"点击量"` // 点击量
Sort int `json:"sort" dc:"排序"` // 排序
}
// ArticleUpdateRes 修改文章结果
type ArticleUpdateRes struct{}
// ArticleStatusReq 文章状态请求
type ArticleStatusReq struct {
gmeta.Meta `method:"put" path:"/api/article/status" summary:"文章状态" permission:"sys:article:status" log:"文章管理-设置状态" logType:"update"`
Id int64 `json:"id" v:"required#缺少ID" dc:"文章ID"` // 文章ID
Status int `json:"status" v:"required#缺少状态" dc:"状态:0-草稿 1-发布"` // 状态
}
// ArticleStatusRes 文章状态结果
type ArticleStatusRes struct{}
// ArticleDeleteReq 删除文章请求
type ArticleDeleteReq struct {
gmeta.Meta `method:"delete" path:"/api/article/delete/:id" summary:"删除文章" permission:"sys:article:delete" log:"文章管理-删除记录" logType:"delete"`
Id int64 `json:"id" v:"required#缺少ID" dc:"文章ID"` // 文章ID
}
// ArticleDeleteRes 删除文章结果
type ArticleDeleteRes struct{}
// ArticleBatchDeleteReq 批量删除文章请求
type ArticleBatchDeleteReq struct {
gmeta.Meta `method:"delete" path:"/api/article/batchDelete" summary:"批量删除文章" permission:"sys:article:batchDelete" log:"文章管理-批量删除记录" logType:"delete"`
Ids []int64 `json:"ids" v:"required#请选择要删除的记录" dc:"文章ID列表"` // 文章ID列表
}
// ArticleBatchDeleteRes 批量删除结果
type ArticleBatchDeleteRes struct{}