package admin
Get desktop application:
View/edit binary Protocol Buffers messages
service admin
admin.proto:17admin service
rpc Captcha (, )
admin.proto:27Get captcha | 获取验证码
message
admin.proto:60The information of captcha | 验证码数据
base.ErrCode errCode = 1
string errMsg = 2
string captchaID = 3
string imgPath = 4
rpc DeleteStructTag (, )
admin.proto:31DeleteStructTag | 去掉struct tag
message
admin.proto:46The information of struct | struct类型数据
base.ErrCode errCode = 1
string errMsg = 2
string structStr = 3
rpc HealthCheck (, )
admin.proto:23Check the system status | 检查系统状态
rpc InitDatabase (, )
admin.proto:19init database
rpc StructToProto (, )
admin.proto:35StructToProto | 转换struct至proto类型数据
message
admin.proto:53The information of proto | proto类型数据
base.ErrCode errCode = 1
string errMsg = 2
string protoStr = 3
service apis
admin.proto:253api service
rpc ApiList (, )
admin.proto:267Get API list | 获取API列表
message
admin.proto:293The request data of API list | API列表请求数据
uint64 page = 1
uint64 pageSize = 2
string path = 3
string description = 4
string method = 5
string group = 6
message
admin.proto:285The response data of API list | API列表数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
rpc CreateApi (, )
admin.proto:255Create API information | 创建或API
rpc DeleteApi (, )
admin.proto:263Delete API information | 删除API信息
rpc UpdateApi (, )
admin.proto:259Update API information | 更新API
service authority
admin.proto:303authorization service
service dictionary
admin.proto:595dictionary service
rpc CreateDictionary (, )
admin.proto:597Create dictionary information | 创建字典信息
Create dictionary KV information | 创建字典键值信息
rpc DeleteDictionary (, )
admin.proto:605Delete dictionary information | 删除字典信息
Delete dictionary KV information | 删除字典键值信息
Get dictionary detail list by dictionary name | 根据字典名获取字典键值列表
message
admin.proto:672The request data of dictionary KV information | 字典名获取字典键值请求数据
string name = 1
message
admin.proto:664The response data of dictionary KV information list | 字典键值列表数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
rpc DictionaryList (, )
admin.proto:609Get dictionary list | 获取字典列表
message
admin.proto:677The request data of dictionary list | 字典列表请求数据
string title = 1
string name = 2
uint64 page = 3
uint64 pageSize = 4
message
admin.proto:644The data of dictionary list | 字典列表数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
rpc UpdateDictionary (, )
admin.proto:601Update dictionary information | 更新字典信息
Update dictionary KV information | 更新字典键值信息
service logs
admin.proto:767logs service
rpc DeleteLogs (, )
admin.proto:773Delete logs | 删除日志信息
rpc GetLogsList (, )
admin.proto:769Get logs list | 获取日志列表
message
admin.proto:797The request data of logs list | 日志列表请求数据
uint64 page = 1
uint64 pageSize = 2
string type = 3
string method = 4
string api = 5
string success = 6
string operator = 7
message
admin.proto:808The response data of logs list | 日志列表返回数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
menu service
service oauth
admin.proto:685oauth service
rpc CreateProvider (, )
admin.proto:687Create Provider information | 创建提供商
rpc DeleteProvider (, )
admin.proto:695Delete provider information | 删除提供商信息
rpc GetProviderList (, )
admin.proto:699Get provider list | 获取提供商列表
message
admin.proto:753The response data of provider list | 提供商列表返回数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
rpc OauthCallback (, )
admin.proto:707Oauth log in callback route | Oauth 登录返回调接口
message
admin.proto:761Oauth login callback request | Oauth 登录回调请求
string state = 1
string code = 2
message
admin.proto:153The log in response data | 登录返回数据
string code = 1
string token = 2
string expire = 3
rpc OauthLogin (, )
admin.proto:703Oauth log in | Oauth 登录
message
admin.proto:715Oauth log in request | Oauth 登录请求
string state = 1
format: random string-provider name | 格式：随机字符串-供应商名称
string provider = 2
string LoginType = 3
Login type for wecom: QRCode, Inside, Quick | 企业微信登录类型：二维码，应用内部，快速 （其他应用的OAuth不需要传）
message
admin.proto:724Redirect information | 跳转网址
base.ErrCode errCode = 1
string errMsg = 2
string url = 3
rpc UpdateProvider (, )
admin.proto:691Update Provider information | 更新提供商
service role
admin.proto:472role service
rpc CreateRole (, )
admin.proto:474Create role information | 创建角色
rpc DeleteRole (, )
admin.proto:482Delete role information | 删除角色信息
rpc RoleByID (, )
admin.proto:486Get role information | 获取角色信息
message
admin.proto:515The response data of role info | 角色信息返回数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 ID = 3
string name = 4
string value = 5
string defaultRouter = 6
uint64 status = 7
string remark = 8
uint32 orderNo = 9
string createdAt = 10
string updatedAt = 11
rpc RoleList (, )
admin.proto:490Get role list | 获取角色列表
message
admin.proto:530The request data of role list | 角色列表请求数据
uint64 page = 1
uint64 pageSize = 2
string name = 3
string status = 4
0: 禁用, 1: 启用
message
admin.proto:538Get role list response | 获取角色列表响应
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
rpc UpdateRole (, )
admin.proto:478Update role information | 更新角色
rpc UpdateRoleStatus (, )
admin.proto:494Set role status | 设置角色状态, 启用1/禁用0
service token
admin.proto:546Token service
rpc DeleteToken (, )
admin.proto:552Delete token information | 删除token信息
message
admin.proto:590Delete request params | token删除请求参数
uint64 userID = 1
rpc TokenList (, )
admin.proto:556Get Token list | 获取token列表
message
admin.proto:582Get token list request params | token列表请求参数
uint64 page = 1
uint64 pageSize = 2
string username = 3
uint64 userID = 4
message
admin.proto:574The response data of Token list | Token列表返回数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
rpc UpdateToken (, )
admin.proto:548Update Token information | 更新Token
service user
admin.proto:84user service
rpc ChangePassword (, )
admin.proto:99Change Password | 修改密码
message
admin.proto:187change user's password request | 修改密码请求参数
uint64 userID = 1
string oldPassword = 2
string newPassword = 3
rpc CreateUser (, )
admin.proto:103Create user's information | 新增用户
rpc DeleteUser (, )
admin.proto:119Delete user information | 删除用户信息
rpc Register (, )
admin.proto:91The login interface does not need to be automatically generated, it has been written in the jwt middleware Log in | 登录 rpc Login(LoginReq) returns (LoginResp) { option (api.post) = "/api/login"; } Register | 注册
message
admin.proto:178register request | 注册参数
string username = 1
string password = 2
string captchaID = 3
string captcha = 4
string email = 5
rpc UpdateProfile (, )
admin.proto:123Update user's profile | 更新用户个人信息
message
admin.proto:170The profile request | 获取个人数据
string nickname = 1
string avatar = 2
string mobile = 3
string email = 4
rpc UpdateUser (, )
admin.proto:107Update user's information | 更新用户
rpc UpdateUserStatus (, )
admin.proto:131Set user's status | 更新用户状态
rpc UserInfo (, )
admin.proto:111Get user basic information | 获取用户基本信息
rpc UserList (, )
admin.proto:115Get user list | 获取用户列表
message
admin.proto:235Get user list request | 获取用户列表请求参数
uint64 page = 1
uint64 pageSize = 2
string username = 3
string nickname = 4
string email = 5
string mobile = 6
uint64 roleID = 7
message
admin.proto:227The response data of user list | 用户列表数据
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
rpc UserPermCode (, )
admin.proto:95Get user's permission code | 获取用户权限码
message
admin.proto:246The permission code for front end permission control | 权限码： 用于前端权限控制
base.ErrCode errCode = 1
string errMsg = 2
repeated string data = 3
rpc UserProfile (, )
admin.proto:127Get user's profile | 获取用户个人信息
message
admin.proto:160The profile in response data | 返回个人数据
base.ErrCode errCode = 1
string errMsg = 2
string nickname = 3
string avatar = 4
string mobile = 5
string email = 6
message
admin.proto:332authorization message The response data of api authorization | API授权数据
Used in: ,
string path = 1
string method = 2
message
admin.proto:274api message The response data of API information | API信息
Used as request type in: apis.CreateApi, apis.UpdateApi
Used as field type in:
uint64 ID = 1
string createdAt = 2
string updatedAt = 3
string path = 4
string description = 5
string group = 6
string method = 7
message
admin.proto:338Create or update api authorization information request | 创建或更新API授权信息
Used as request type in: authority.CreateAuthority, authority.UpdateApiAuthority
uint64 roleID = 1
repeated data = 2
message
admin.proto:392Create or update menu information request params | 创建或更新菜单信息参数
Used as request type in: menu.CreateMenu, menu.UpdateMenu
uint64 ID = 1
uint64 parentID = 2
uint32 level = 3
string path = 4
string name = 5
string redirect = 6
string component = 7
uint32 orderNo = 8
bool disabled = 9
uint32 menuType = 10
optional meta = 11
message
admin.proto:194Create or update user information request | 创建或更新用户信息
Used as request type in: user.CreateUser, user.UpdateUser
uint64 ID = 1
string avatar = 2
uint64 roleID = 3
string mobile = 4
string email = 5
uint64 status = 6
string username = 7
string nickname = 8
string password = 9
message
admin.proto:78uint64 roleID = 1
optional info = 2
message
admin.proto:652The dictionary KV information | 字典键值信息
Used as request type in: dictionary.CreateDictionaryDetail, dictionary.UpdateDictionaryDetail
Used as field type in:
uint64 ID = 1
string title = 2
string key = 3
string value = 4
uint64 status = 5
string createdAt = 6
string updatedAt = 7
uint64 parentID = 8
message
admin.proto:633The response data of dictionary information | 字典信息
Used as request type in: dictionary.CreateDictionary, dictionary.UpdateDictionary
Used as field type in:
uint64 ID = 1
string title = 2
string name = 3
uint64 status = 4
string description = 5
string createdAt = 6
string updatedAt = 7
message
admin.proto:139login request | 登录参数
string username = 1
string password = 2
string captchaID = 3
string captcha = 4
message
admin.proto:781The response data of logs | 日志信息
Used in:
string type = 1
string method = 2
string api = 3
bool success = 4
string reqContent = 5
string respContent = 6
string ip = 7
string userAgent = 8
string operator = 9
uint32 time = 10
string createdAt = 11
string updatedAt = 12
message
admin.proto:352The request data of menu authorization | 菜单授权请求数据
Used as request type in: authority.CreateMenuAuthority, authority.UpdateMenuAuthority
uint64 roleID = 1
repeated uint64 MenuIDs = 2
message
admin.proto:407The response data of menu information | 菜单返回数据
Used in:
uint64 ID = 1
string createdAt = 2
string updatedAt = 3
uint32 level = 4
uint64 parentID = 5
string path = 6
string name = 7
string redirect = 8
string component = 9
uint32 orderNo = 10
bool disabled = 11
uint32 menuType = 12
repeated children = 13
optional meta = 14
message
admin.proto:450The data of menu list | 菜单列表数据
Used as response type in: menu.MenuByRole, menu.MenuList
base.ErrCode errCode = 1
string errMsg = 2
uint64 total = 3
repeated data = 4
message
admin.proto:458The response data of role menu list data | 角色菜单列表数据
uint32 parentID = 1
uint32 level = 2
string path = 3
string name = 4
string redirect = 5
string component = 6
uint32 orderNo = 7
bool disabled = 8
repeated children = 9
optional meta = 10
message
admin.proto:425The meta data of menu | 菜单的meta数据
Used in: , ,
string title = 1
string icon = 2
bool hideMenu = 3
bool hideBreadcrumb = 4
string currentActiveMenu = 5
bool ignoreKeepAlive = 6
bool hideTab = 7
string frameSrc = 8
bool carryParam = 9
bool hideChildrenInMenu = 10
bool affix = 11
uint32 dynamicLevel = 12
string realPath = 13
message
admin.proto:73Used in: ,
string path = 1
string method = 2
message
admin.proto:731The response data of oauth provider information | 提供者信息
Used as request type in: oauth.CreateProvider, oauth.UpdateProvider
Used as field type in:
uint64 id = 1
string name = 2
string clientID = 3
string clientSecret = 4
string redirectUrl = 5
string scopes = 6
string authUrl = 7
string tokenUrl = 8
uint64 authStyle = 9
string infoUrl = 10
string createdAt = 11
string updatedAt = 12
message
admin.proto:746uint64 page = 1
uint64 pageSize = 2
string name = 3
message
admin.proto:502Create or update role information params | 创建或更新角色信息参数
Used as request type in: role.CreateRole, role.UpdateRole
Used as field type in:
uint64 ID = 1
string name = 2
string value = 3
string defaultRouter = 4
uint64 status = 5
string remark = 6
uint32 orderNo = 7
string createdAt = 8
string updatedAt = 9
message
admin.proto:147The simple role data | 简单的角色数据
string roleName = 1
string value = 2
message
admin.proto:41The request of struct | struct请求类型数据
Used as request type in: admin.DeleteStructTag, admin.StructToProto
string structStr = 1
message
admin.proto:562The response data of Token information | Token信息
Used as request type in: token.UpdateToken
Used as field type in:
uint64 ID = 1
string createdAt = 2
string updatedAt = 3
uint64 userID = 4
string userName = 5
string token = 6
string source = 7
string expiredAt = 8
message
admin.proto:68casbin
uint64 roleID = 1
repeated rules = 2
message
admin.proto:207The response data of user's information | 用户信息返回数据
Used as response type in: user.UserInfo
Used as field type in:
base.ErrCode errCode = 1
string errMsg = 2
uint64 ID = 3
string avatar = 4
uint64 roleID = 5
string mobile = 6
string email = 7
uint64 status = 8
string username = 9
string nickname = 10
string roleName = 11
string createdAt = 12
string updatedAt = 13
string roleValue = 14
string sideMode = 15
string defaultRouter = 16