EasyGoAdmin_GoFrame_EleVue/api/v1/role.go

package v1

import (
	"github.com/gogf/gf/v2/os/gtime"
	"github.com/gogf/gf/v2/util/gmeta"
)

// ============================== 角色模块 ==============================

// RolePageReq 角色分页请求
// 支持关键词、角色名称等条件组合查询
type RolePageReq struct {
	gmeta.Meta `method:"get" path:"/api/role/page" summary:"角色分页" permission:"sys:role:page" log:"角色管理-查询分页记录" logType:"query"`
	PageReq           // 分页基础参数
	Keyword    string `json:"keyword" dc:"关键词（名称/编码模糊）"` // 关键词，名称或编码模糊匹配
	Name       string `json:"name" dc:"角色名称模糊"`          // 角色名称模糊匹配
}

// RoleItem 角色行数据
// 用于角色分页列表等场景的角色基础信息
type RoleItem struct {
	Id            int64       `json:"id"`            // 主键ID
	TenantId      int         `json:"tenantId"`      // 租户ID
	Name          string      `json:"name"`          // 角色名称
	Code          string      `json:"code"`          // 角色编码
	DataScope     int         `json:"dataScope"`     // 数据范围：1-全部 2-本部门及以下 3-本部门 4-仅本人
	DataScopeText string      `json:"dataScopeText"` // 数据范围文案（字典驱动）
	Sort          int         `json:"sort"`          // 排序
	Note          string      `json:"note"`          // 备注
	UserCount     int         `json:"userCount"`     // 关联用户数
	CreateUser    string      `json:"createUser"`    // 创建人
	CreateTime    *gtime.Time `json:"createTime"`    // 创建时间
}

// RolePageRes 角色分页结果
type RolePageRes = PageData[RoleItem]

// RoleListReq 角色全量列表请求
type RoleListReq struct {
	gmeta.Meta `method:"get" path:"/api/role/list" summary:"角色列表" permission:"sys:role:list" log:"角色管理-查询列表" logType:"query"`
	Keyword    string `json:"keyword" dc:"关键词"` // 关键词
}

// RoleListItem 角色列表行数据
// 精简结构，仅包含列表展示所需字段
type RoleListItem struct {
	Id   int64  `json:"id"`   // 主键ID
	Name string `json:"name"` // 角色名称
	Code string `json:"code"` // 角色编码
	Sort int    `json:"sort"` // 排序
}

// RoleListRes 角色列表结果
type RoleListRes = []RoleListItem

// RoleDetailReq 角色详情请求
type RoleDetailReq struct {
	gmeta.Meta `method:"get" path:"/api/role/detail/:id" summary:"角色详情" permission:"sys:role:detail" log:"角色管理-查询详情" logType:"query"`
	Id         int64 `json:"id" v:"required#缺少ID" dc:"角色ID"` // 角色ID
}

// RoleDetailRes 角色详情结果
type RoleDetailRes struct {
	Id        int64  `json:"id"`        // 主键ID
	TenantId  int    `json:"tenantId"`  // 租户ID
	Name      string `json:"name"`      // 角色名称
	Code      string `json:"code"`      // 角色编码
	DataScope int    `json:"dataScope"` // 数据范围：1-全部 2-本部门及以下 3-本部门 4-仅本人
	Sort      int    `json:"sort"`      // 排序
	Note      string `json:"note"`      // 备注
}

// RoleAddReq 新增角色请求
type RoleAddReq struct {
	gmeta.Meta `method:"post" path:"/api/role/add" summary:"新增角色" permission:"sys:role:add" log:"角色管理-新增记录" logType:"add"`
	Name       string `json:"name" v:"required#请输入角色名称" dc:"角色名称"`                                        // 角色名称
	Code       string `json:"code" v:"required#请输入角色编码|length:2,30#编码长度需在2~30位" dc:"角色编码"`                // 角色编码
	DataScope  int    `json:"dataScope" v:"in:1,2,3,4#数据范围不合法" d:"1" dc:"数据范围：1-全部 2-本部门及以下 3-本部门 4-仅本人"` // 数据范围
	Sort       int    `json:"sort" dc:"排序"`                                                               // 排序
	Note       string `json:"note" dc:"备注"`                                                               // 备注
}

// RoleUpdateReq 修改角色请求
type RoleUpdateReq struct {
	gmeta.Meta `method:"put" path:"/api/role/update" summary:"修改角色" permission:"sys:role: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" dc:"角色编码（不允许修改）"`                                                // 角色编码，不允许修改
	DataScope  int    `json:"dataScope" v:"in:1,2,3,4#数据范围不合法" dc:"数据范围：1-全部 2-本部门及以下 3-本部门 4-仅本人"` // 数据范围
	Sort       int    `json:"sort" dc:"排序"`                                                         // 排序
	Note       string `json:"note" dc:"备注"`                                                         // 备注
}

// RoleUpdateRes 修改角色结果
type RoleUpdateRes struct{}

// RoleDeleteReq 删除角色请求
type RoleDeleteReq struct {
	gmeta.Meta `method:"delete" path:"/api/role/delete/:id" summary:"删除角色" permission:"sys:role:delete" log:"角色管理-删除记录" logType:"delete"`
	Id         int64 `json:"id" v:"required#缺少ID" dc:"角色ID"` // 角色ID
}

// RoleDeleteRes 删除角色结果
type RoleDeleteRes struct{}

// RoleBatchDeleteReq 批量删除角色请求
type RoleBatchDeleteReq struct {
	gmeta.Meta `method:"delete" path:"/api/role/batchDelete" summary:"批量删除角色" permission:"sys:role:batchDelete" log:"角色管理-批量删除记录" logType:"delete"`
	Ids        []int64 `json:"ids" v:"required#请选择要删除的记录" dc:"角色ID列表"` // 角色ID列表
}

// RoleBatchDeleteRes 批量删除结果
type RoleBatchDeleteRes struct{}

// RoleMenuListReq 角色菜单权限请求
// 返回菜单平铺列表并附带勾选状态
type RoleMenuListReq struct {
	gmeta.Meta `method:"get" path:"/api/role/menu/list/:roleId" summary:"查询角色菜单权限" permission:"sys:role:getPermission" log:"角色管理-查询角色菜单" logType:"query"`
	RoleId     int64 `json:"roleId" v:"required#缺少角色ID" dc:"角色ID"` // 角色ID
}

// RoleMenuItem 菜单勾选行数据
// 供前端构建树形结构并依据 checked 标记勾选状态
type RoleMenuItem struct {
	Id         int64  `json:"id"`         // 菜单ID
	ParentId   int    `json:"parentId"`   // 上级菜单ID
	Name       string `json:"name"`       // 菜单名称
	Icon       string `json:"icon"`       // 图标
	Icon2      string `json:"icon2"`      // 菜单图标2
	Path       string `json:"path"`       // 路由路径
	Component  string `json:"component"`  // 前端组件路径
	Permission string `json:"permission"` // 权限节点标识
	Target     int    `json:"target"`     // 打开方式
	Type       int    `json:"type"`       // 类型：0-菜单 1-权限节点
	Status     int    `json:"status"`     // 状态
	Hide       int    `json:"hide"`       // 是否可见
	Sort       int    `json:"sort"`       // 排序
	Checked    bool   `json:"checked"`    // 是否已勾选
}

// RoleMenuListRes 角色菜单勾选列表结果（平铺）
type RoleMenuListRes = []RoleMenuItem

// RoleSavePermissionReq 保存角色菜单权限请求
type RoleSavePermissionReq struct {
	gmeta.Meta `method:"post" path:"/api/role/menu/save" summary:"保存角色菜单权限" permission:"sys:role:savePermission" log:"角色管理-保存权限" logType:"update"`
	RoleId     int64   `json:"roleId" v:"required#缺少角色ID" dc:"角色ID"` // 角色ID
	MenuIds    []int64 `json:"menuIds" dc:"菜单ID列表（含半选父级）"`           // 菜单ID列表
}

// RoleSavePermissionRes 保存角色菜单权限结果
type RoleSavePermissionRes struct{}