Documentation ¶
Overview ¶
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2022-01-09 21:25
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2021-12-15 17:34
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2021-12-10 13:48
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2021-12-14 11:07
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2021-12-12 02:23
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2021-12-13 11:23
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2022-01-18 15:59
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2022-01-07 16:51
Package system @program: arco-design-pro-gin @author: [lliuhuan](https://github.com/lliuhuan) @create: 2021-12-10 17:32
Index ¶
- type ApiGroup
- type AuthorityApi
- type AuthorityMenuApi
- func (a *AuthorityMenuApi) AddBaseMenu(c *gin.Context)
- func (a *AuthorityMenuApi) AddMenuAuthority(c *gin.Context)
- func (a *AuthorityMenuApi) DeleteBaseMenu(c *gin.Context)
- func (a *AuthorityMenuApi) GetBaseMenuById(c *gin.Context)
- func (a *AuthorityMenuApi) GetBaseMenuTree(c *gin.Context)
- func (a *AuthorityMenuApi) GetMenu(c *gin.Context)
- func (a *AuthorityMenuApi) GetMenuAuthority(c *gin.Context)
- func (a *AuthorityMenuApi) GetMenuList(c *gin.Context)
- func (a *AuthorityMenuApi) UpdateBaseMenu(c *gin.Context)
- type BaseApi
- func (b *BaseApi) Captcha(c *gin.Context)
- func (b *BaseApi) DeleteUser(c *gin.Context)
- func (b *BaseApi) GetUserInfo(c *gin.Context)
- func (b *BaseApi) GetUserList(c *gin.Context)
- func (b *BaseApi) Login(c *gin.Context)
- func (b *BaseApi) Register(c *gin.Context)
- func (b *BaseApi) SetUserAuthorities(c *gin.Context)
- func (b *BaseApi) SetUserAuthority(c *gin.Context)
- func (b *BaseApi) SetUserInfo(c *gin.Context)
- type CasbinApi
- type InitDBApi
- type JwtApi
- type OperationRecordApi
- func (s *OperationRecordApi) CreateSysOperationRecord(c *gin.Context)
- func (s *OperationRecordApi) DeleteSysOperationRecord(c *gin.Context)
- func (s *OperationRecordApi) DeleteSysOperationRecordByIds(c *gin.Context)
- func (s *OperationRecordApi) FindSysOperationRecord(c *gin.Context)
- func (s *OperationRecordApi) GetSysOperationRecordList(c *gin.Context)
- type SysApi
- type SystemApiApi
- func (s *SystemApiApi) CreateApi(c *gin.Context)
- func (s *SystemApiApi) DeleteApi(c *gin.Context)
- func (s *SystemApiApi) DeleteApisByIds(c *gin.Context)
- func (s *SystemApiApi) GetAllApis(c *gin.Context)
- func (s *SystemApiApi) GetApiById(c *gin.Context)
- func (s *SystemApiApi) GetApiList(c *gin.Context)
- func (s *SystemApiApi) UpdateApi(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiGroup ¶
type ApiGroup struct { JwtApi SysApi BaseApi InitDBApi CasbinApi AuthorityApi SystemApiApi AuthorityMenuApi OperationRecordApi }
type AuthorityApi ¶
type AuthorityApi struct { }
func (*AuthorityApi) CopyAuthority ¶
func (a *AuthorityApi) CopyAuthority(c *gin.Context)
CopyAuthority 拷贝角色 @Tags Authority @Summary 拷贝角色 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body response.SysAuthorityCopyResponse true "旧角色id, 新权限id, 新权限名, 新父角色id" @Success 200 {string} string "{"success":true,"data":{},"msg":"拷贝成功"}" @Router /authority/copy [post]
func (*AuthorityApi) CreateAuthority ¶
func (a *AuthorityApi) CreateAuthority(c *gin.Context)
CreateAuthority 创建角色 @Tags Authority @Summary 创建角色 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysAuthority true "权限id, 权限名, 父角色id" @Success 200 {string} string "{"success":true,"data":{},"msg":"创建成功"}" @Router /authority [post]
func (*AuthorityApi) DeleteAuthority ¶
func (a *AuthorityApi) DeleteAuthority(c *gin.Context)
DeleteAuthority 删除角色 @Tags Authority @Summary 删除角色 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysAuthority true "删除角色" @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}" @Router /authority [delete]
func (*AuthorityApi) GetAuthorityList ¶
func (a *AuthorityApi) GetAuthorityList(c *gin.Context)
GetAuthorityList 分页获取角色列表 @Tags Authority @Summary 分页获取角色列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.PageInfo true "页码, 每页大小" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /authority [get]
func (*AuthorityApi) UpdateAuthority ¶
func (a *AuthorityApi) UpdateAuthority(c *gin.Context)
UpdateAuthority 更新角色信息 @Tags Authority @Summary 更新角色信息 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysAuthority true "权限id, 权限名, 父角色id" @Success 200 {string} string "{"success":true,"data":{},"msg":"更新成功"}" @Router /authority [put]
type AuthorityMenuApi ¶
type AuthorityMenuApi struct { }
func (*AuthorityMenuApi) AddBaseMenu ¶
func (a *AuthorityMenuApi) AddBaseMenu(c *gin.Context)
AddBaseMenu 新增菜单 @Tags Menu @Summary 新增菜单 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysBaseMenu true "路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记" @Success 200 {string} string "{"success":true,"data":{},"msg":"添加成功"}" @Router /menus [post]
func (*AuthorityMenuApi) AddMenuAuthority ¶
func (a *AuthorityMenuApi) AddMenuAuthority(c *gin.Context)
AddMenuAuthority 增加menu和角色关联关系 @Tags AuthorityMenu @Summary 增加menu和角色关联关系 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body systemReq.AddMenuAuthorityInfo true "角色ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"添加成功"}" @Router /menu/auth [post]
func (*AuthorityMenuApi) DeleteBaseMenu ¶
func (a *AuthorityMenuApi) DeleteBaseMenu(c *gin.Context)
DeleteBaseMenu 删除菜单 @Tags Menu @Summary 删除菜单 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data uri request.GetById true "菜单id" @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}" @Router /menus/:id [delete]
func (*AuthorityMenuApi) GetBaseMenuById ¶
func (a *AuthorityMenuApi) GetBaseMenuById(c *gin.Context)
GetBaseMenuById 根据id获取菜单 @Tags Menu @Summary 根据id获取菜单 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.GetById true "菜单id" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /menus/:id [get]
func (*AuthorityMenuApi) GetBaseMenuTree ¶
func (a *AuthorityMenuApi) GetBaseMenuTree(c *gin.Context)
GetBaseMenuTree 获取用户动态路由 @Tags AuthorityMenu @Summary 获取用户动态路由 @Security ApiKeyAuth @Produce application/json @Param data body request.Empty true "空" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /menu/base [get]
func (*AuthorityMenuApi) GetMenu ¶
func (a *AuthorityMenuApi) GetMenu(c *gin.Context)
GetMenu 获取用户动态路由 @Tags AuthorityMenu @Summary 获取用户动态路由 @Security ApiKeyAuth @Produce application/json @Param data body request.Empty true "空" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /menus/user [get]
func (*AuthorityMenuApi) GetMenuAuthority ¶
func (a *AuthorityMenuApi) GetMenuAuthority(c *gin.Context)
GetMenuAuthority 获取指定角色menu @Tags AuthorityMenu @Summary 获取指定角色menu @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.GetAuthorityId true "角色ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /menus/auth [get]
func (*AuthorityMenuApi) GetMenuList ¶
func (a *AuthorityMenuApi) GetMenuList(c *gin.Context)
GetMenuList 分页获取基础menu列表 @Tags Menu @Summary 分页获取基础menu列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.PageInfo true "页码, 每页大小" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /menus [get]
func (*AuthorityMenuApi) UpdateBaseMenu ¶
func (a *AuthorityMenuApi) UpdateBaseMenu(c *gin.Context)
UpdateBaseMenu 更新菜单 @Tags Menu @Summary 更新菜单 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysBaseMenu true "路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记" @Success 200 {string} string "{"success":true,"data":{},"msg":"更新成功"}" @Router /menus [put]
type BaseApi ¶
type BaseApi struct { }
func (*BaseApi) Captcha ¶
Captcha 生成验证码 @Tags Base @Summary 生成验证码 @Security ApiKeyAuth @accept application/json @Produce application/json @Success 200 {string} string "{"success":true,"data":{},"msg":"验证码获取成功"}" @Router /base/captcha [post]
func (*BaseApi) DeleteUser ¶
DeleteUser 删除用户 @Tags SysUser @Summary 删除用户 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.GetById true "用户ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}" @Router /users/:id [delete]
func (*BaseApi) GetUserInfo ¶
GetUserInfo 获取用户信息 @Tags SysUser @Summary 获取用户信息 @Security ApiKeyAuth @accept application/json @Produce application/json @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /user/getUserInfo [get]
func (*BaseApi) GetUserList ¶
GetUserList 分页获取用户列表 @Tags SysUser @Summary 分页获取用户列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.PageInfo true "页码, 每页大小" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /users [get]
func (*BaseApi) Login ¶
Login 用户登录 @Tags Base @Summary 用户登录 @Produce application/json @Param data body systemReq.Login true "用户名, 密码, 验证码" @Success 200 {string} string "{"success":true,"data":{},"msg":"登陆成功"}" @Router /bases/login [post]
func (*BaseApi) Register ¶
Register 用户注册账号 @Tags SysUser @Summary 用户注册账号 @Produce application/json @Param data body systemReq.Register true "用户名, 昵称, 密码, 角色ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"注册成功"}" @Router /users/register [post]
func (*BaseApi) SetUserAuthorities ¶
SetUserAuthorities 设置用户权限 @Tags SysUser @Summary 设置用户权限 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body systemReq.SetUserAuthorities true "用户UUID, 角色ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"修改成功"}" @Router /users/authorities [post]
func (*BaseApi) SetUserAuthority ¶
SetUserAuthority 更改用户权限 @Tags SysUser @Summary 更改用户权限 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body systemReq.SetUserAuth true "用户UUID, 角色ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"修改成功"}" @Router /users/authority [post]
func (*BaseApi) SetUserInfo ¶
SetUserInfo 设置用户信息 @Tags SysUser @Summary 设置用户信息 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysUser true "ID, 用户名, 昵称, 头像链接" @Success 200 {string} string "{"success":true,"data":{},"msg":"设置成功"}" @Router /users [put]
type CasbinApi ¶
type CasbinApi struct { }
func (*CasbinApi) GetPolicyPathByAuthorityId ¶
GetPolicyPathByAuthorityId 获取权限列表 @Tags Casbin @Summary 获取权限列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.CasbinInReceive true "权限id, 权限模型列表" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /v1/casbin/:id [get]
func (*CasbinApi) UpdateCasbin ¶
UpdateCasbin @Tags Casbin @Summary 更新角色api权限 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.CasbinInReceive true "权限id, 权限模型列表" @Success 200 {string} string "{"success":true,"data":{},"msg":"更新成功"}" @Router /v1/casbin [put]
type InitDBApi ¶
type InitDBApi struct{}
type JwtApi ¶
type JwtApi struct { }
func (*JwtApi) JsonInBlacklist ¶
JsonInBlacklist @Tags Jwt @Summary jwt加入黑名单 @Security ApiKeyAuth @accept application/json @Produce application/json @Success 200 {string} string "{"success":true,"data":{},"msg":"拉黑成功"}" @Router /jwt/jsonInBlacklist [post]
type OperationRecordApi ¶
type OperationRecordApi struct { }
func (*OperationRecordApi) CreateSysOperationRecord ¶
func (s *OperationRecordApi) CreateSysOperationRecord(c *gin.Context)
CreateSysOperationRecord 创建SysOperationRecord @Tags SysOperationRecord @Summary 创建SysOperationRecord @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysOperationRecord true "创建SysOperationRecord" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /v1/operation/record [post]
func (*OperationRecordApi) DeleteSysOperationRecord ¶
func (s *OperationRecordApi) DeleteSysOperationRecord(c *gin.Context)
DeleteSysOperationRecord 删除SysOperationRecord @Tags SysOperationRecord @Summary 删除SysOperationRecord @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysOperationRecord true "SysOperationRecord模型" @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}" @Router /v1/operation/record [delete]
func (*OperationRecordApi) DeleteSysOperationRecordByIds ¶
func (s *OperationRecordApi) DeleteSysOperationRecordByIds(c *gin.Context)
DeleteSysOperationRecordByIds 批量删除SysOperationRecord @Tags SysOperationRecord @Summary 批量删除SysOperationRecord @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.IdsReq true "批量删除SysOperationRecord" @Success 200 {string} string "{"success":true,"data":{},"msg":"批量删除成功"}" @Router /v1/operation/record/byIds [delete]
func (*OperationRecordApi) FindSysOperationRecord ¶
func (s *OperationRecordApi) FindSysOperationRecord(c *gin.Context)
FindSysOperationRecord 用id查询SysOperationRecord @Tags SysOperationRecord @Summary 用id查询SysOperationRecord @Security ApiKeyAuth @accept application/json @Produce application/json @Param data uri system.SysOperationRecord true "Id" @Success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}" @Router /v1/operation/record/:id [get]
func (*OperationRecordApi) GetSysOperationRecordList ¶
func (s *OperationRecordApi) GetSysOperationRecordList(c *gin.Context)
GetSysOperationRecordList 分页获取SysOperationRecord列表 @Tags SysOperationRecord @Summary 分页获取SysOperationRecord列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data query request.SysOperationRecordSearch true "页码, 每页大小, 搜索条件" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /v1/operation/record [get]
type SysApi ¶
type SysApi struct { }
func (*SysApi) GetServerInfo ¶
GetServerInfo 获取服务器信息 @Tags System @Summary 获取服务器信息 @Security ApiKeyAuth @Produce application/json @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /system/info [get]
func (*SysApi) ReloadSystem ¶
ReloadSystem 重启系统 @Tags System @Summary 重启系统 @Security ApiKeyAuth @Produce application/json @Success 200 {string} string "{"code":0,"data":{},"msg":"重启系统成功"}" @Router /system/reload [post]
type SystemApiApi ¶
type SystemApiApi struct { }
func (*SystemApiApi) CreateApi ¶
func (s *SystemApiApi) CreateApi(c *gin.Context)
CreateApi 创建基础api @Tags SysApi @Summary 创建基础api @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysApi true "api路径, api中文描述, api组, 方法" @Success 200 {string} string "{"success":true,"data":{},"msg":"创建成功"}" @Router /v1/api [post]
func (*SystemApiApi) DeleteApi ¶
func (s *SystemApiApi) DeleteApi(c *gin.Context)
DeleteApi 删除api @Tags SysApi @Summary 删除api @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysApi true "ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}" @Router /v1/api [delete]
func (*SystemApiApi) DeleteApisByIds ¶
func (s *SystemApiApi) DeleteApisByIds(c *gin.Context)
DeleteApisByIds 删除选中Api @Tags SysApi @Summary 删除选中Api @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.IdsReq true "ID" @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}" @Router /api/byIds [delete]
func (*SystemApiApi) GetAllApis ¶
func (s *SystemApiApi) GetAllApis(c *gin.Context)
GetAllApis 获取所有的Api 不分页 @Tags SysApi @Summary 获取所有的Api 不分页 @Security ApiKeyAuth @accept application/json @Produce application/json @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /v1/api/all [get]
func (*SystemApiApi) GetApiById ¶
func (s *SystemApiApi) GetApiById(c *gin.Context)
GetApiById 根据id获取api @Tags SysApi @Summary 根据id获取api @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.GetById true "根据id获取api" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /api/:id [get]
func (*SystemApiApi) GetApiList ¶
func (s *SystemApiApi) GetApiList(c *gin.Context)
GetApiList 分页获取API列表 @Tags SysApi @Summary 分页获取API列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body systemReq.SearchApiParams true "分页获取API列表" @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}" @Router /api/getApiList [post]
func (*SystemApiApi) UpdateApi ¶
func (s *SystemApiApi) UpdateApi(c *gin.Context)
UpdateApi 创建基础api @Tags SysApi @Summary 创建基础api @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body system.SysApi true "api路径, api中文描述, api组, 方法" @Success 200 {string} string "{"success":true,"data":{},"msg":"修改成功"}" @Router /v1/api [put]