// Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT // This file was generated by swaggo/swag package docs import ( "bytes" "encoding/json" "strings" "text/template" "github.com/swaggo/swag" ) var doc = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "contact": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/base/captcha": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Base" ], "summary": "生成验证码", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"验证码获取成功\"}", "schema": { "type": "string" } } } } }, "/base/login": { "post": { "produces": [ "application/json" ], "tags": [ "Base" ], "summary": "用户登录", "parameters": [ { "description": "用户名, 密码, 验证码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.Login" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}", "schema": { "type": "string" } } } } }, "/jwt/jsonInBlacklist": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Jwt" ], "summary": "jwt加入黑名单", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"拉黑成功\"}", "schema": { "type": "string" } } } } }, "/menu/addBaseMenu": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Menu" ], "summary": "新增菜单", "parameters": [ { "description": "路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/web.SysBaseMenu" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"添加成功\"}", "schema": { "type": "string" } } } } }, "/menu/addMenuAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AuthorityMenu" ], "summary": "增加menu和角色关联关系", "parameters": [ { "description": "角色ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.AddMenuAuthorityInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"添加成功\"}", "schema": { "type": "string" } } } } }, "/menu/deleteBaseMenu": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Menu" ], "summary": "删除菜单", "parameters": [ { "description": "菜单id", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetById" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/menu/getBaseMenuById": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Menu" ], "summary": "根据id获取菜单", "parameters": [ { "description": "菜单id", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetById" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/getBaseMenuTree": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "AuthorityMenu" ], "summary": "获取用户动态路由", "parameters": [ { "description": "空", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.Empty" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/getMenu": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "AuthorityMenu" ], "summary": "获取用户动态路由", "parameters": [ { "description": "空", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.Empty" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/getMenuAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AuthorityMenu" ], "summary": "获取指定角色menu", "parameters": [ { "description": "角色ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetAuthorityId" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/getMenuList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Menu" ], "summary": "分页获取基础menu列表", "parameters": [ { "description": "页码, 每页大小", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/updateBaseMenu": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Menu" ], "summary": "更新菜单", "parameters": [ { "description": "路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/web.SysBaseMenu" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } } }, "/system/getServerInfo": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "System" ], "summary": "获取服务器信息", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/system/getSystemConfig": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "System" ], "summary": "获取配置文件内容", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/system/reloadSystem": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "System" ], "summary": "重启系统", "responses": { "200": { "description": "{\"code\":0,\"data\":{},\"msg\":\"重启系统成功\"}", "schema": { "type": "string" } } } } }, "/system/setSystemConfig": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "System" ], "summary": "设置配置文件内容", "parameters": [ { "description": "设置配置文件内容", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/web.System" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"设置成功\"}", "schema": { "type": "string" } } } } }, "/user/changePassword": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "用户修改密码", "parameters": [ { "description": "用户名, 原密码, 新密码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.ChangePasswordStruct" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}", "schema": { "type": "string" } } } } }, "/user/deleteUser": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "删除用户", "parameters": [ { "description": "用户ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetById" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/user/getUserInfo": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "获取用户信息", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/user/getUserList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "分页获取用户列表", "parameters": [ { "description": "页码, 每页大小", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/user/register": { "post": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "用户注册账号", "parameters": [ { "description": "用户名, 昵称, 密码, 角色ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.Register" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"注册成功\"}", "schema": { "type": "string" } } } } }, "/user/setUserAuthorities": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "设置用户权限", "parameters": [ { "description": "用户UUID, 角色ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.SetUserAuthorities" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}", "schema": { "type": "string" } } } } }, "/user/setUserAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "更改用户权限", "parameters": [ { "description": "用户UUID, 角色ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.SetUserAuth" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}", "schema": { "type": "string" } } } } }, "/user/setUserInfo": { "put": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "设置用户信息", "parameters": [ { "description": "ID, 用户名, 昵称, 头像链接", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/web.SysUser" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"设置成功\"}", "schema": { "type": "string" } } } } } }, "definitions": { "config.AliyunOSS": { "type": "object", "properties": { "accessKeyId": { "type": "string" }, "accessKeySecret": { "type": "string" }, "basePath": { "type": "string" }, "bucketName": { "type": "string" }, "bucketUrl": { "type": "string" }, "endpoint": { "type": "string" } } }, "config.Autocode": { "type": "object", "properties": { "root": { "type": "string" }, "server": { "type": "string" }, "serverApi": { "type": "string" }, "serverInitialize": { "type": "string" }, "serverModel": { "type": "string" }, "serverRequest": { "type": "string" }, "serverRouter": { "type": "string" }, "serverService": { "type": "string" }, "transferRestart": { "type": "boolean" }, "web": { "type": "string" }, "webApi": { "type": "string" }, "webForm": { "type": "string" }, "webTable": { "type": "string" } } }, "config.Captcha": { "type": "object", "properties": { "imgHeight": { "description": "验证码高度", "type": "integer" }, "imgWidth": { "description": "验证码宽度", "type": "integer" }, "keyLong": { "description": "验证码长度", "type": "integer" } } }, "config.Casbin": { "type": "object", "properties": { "modelPath": { "description": "存放casbin模型的相对路径", "type": "string" } } }, "config.Detail": { "type": "object", "properties": { "compareField": { "description": "需要比较时间的字段", "type": "string" }, "interval": { "description": "时间间隔", "type": "string" }, "tableName": { "description": "需要清理的表名", "type": "string" } } }, "config.Email": { "type": "object", "properties": { "from": { "description": "收件人", "type": "string" }, "host": { "description": "服务器地址", "type": "string" }, "isSSL": { "description": "是否SSL", "type": "boolean" }, "nickname": { "description": "昵称", "type": "string" }, "port": { "description": "端口", "type": "integer" }, "secret": { "description": "密钥", "type": "string" }, "to": { "description": "收件人:多个以英文逗号分隔", "type": "string" } } }, "config.Excel": { "type": "object", "properties": { "dir": { "type": "string" } } }, "config.JWT": { "type": "object", "properties": { "bufferTime": { "description": "缓冲时间", "type": "integer" }, "expiresTime": { "description": "过期时间", "type": "integer" }, "signingKey": { "description": "jwt签名", "type": "string" } } }, "config.Local": { "type": "object", "properties": { "path": { "description": "本地文件路径", "type": "string" } } }, "config.Mysql": { "type": "object", "properties": { "config": { "description": "高级配置", "type": "string" }, "dbname": { "description": "数据库名", "type": "string" }, "logMode": { "description": "是否开启Gorm全局日志", "type": "string" }, "logZap": { "description": "是否通过zap写入日志文件", "type": "boolean" }, "maxIdleConns": { "description": "空闲中的最大连接数", "type": "integer" }, "maxOpenConns": { "description": "打开到数据库的最大连接数", "type": "integer" }, "password": { "description": "数据库密码", "type": "string" }, "path": { "description": "服务器地址:端口", "type": "string" }, "username": { "description": "数据库用户名", "type": "string" } } }, "config.Qiniu": { "type": "object", "properties": { "accessKey": { "description": "秘钥AK", "type": "string" }, "bucket": { "description": "空间名称", "type": "string" }, "imgPath": { "description": "CDN加速域名", "type": "string" }, "secretKey": { "description": "秘钥SK", "type": "string" }, "useCdnDomains": { "description": "上传是否使用CDN上传加速", "type": "boolean" }, "useHttps": { "description": "是否使用https", "type": "boolean" }, "zone": { "description": "存储区域", "type": "string" } } }, "config.Redis": { "type": "object", "properties": { "addr": { "description": "服务器地址:端口", "type": "string" }, "db": { "description": "redis的哪个数据库", "type": "integer" }, "password": { "description": "密码", "type": "string" } } }, "config.Server": { "type": "object", "properties": { "aliyunOSS": { "$ref": "#/definitions/config.AliyunOSS" }, "autoCode": { "description": "auto", "$ref": "#/definitions/config.Autocode" }, "captcha": { "$ref": "#/definitions/config.Captcha" }, "casbin": { "$ref": "#/definitions/config.Casbin" }, "email": { "$ref": "#/definitions/config.Email" }, "excel": { "$ref": "#/definitions/config.Excel" }, "jwt": { "$ref": "#/definitions/config.JWT" }, "local": { "description": "oss", "$ref": "#/definitions/config.Local" }, "mysql": { "description": "gorm", "$ref": "#/definitions/config.Mysql" }, "qiniu": { "$ref": "#/definitions/config.Qiniu" }, "redis": { "$ref": "#/definitions/config.Redis" }, "system": { "$ref": "#/definitions/config.System" }, "tencentCOS": { "$ref": "#/definitions/config.TencentCOS" }, "timer": { "$ref": "#/definitions/config.Timer" }, "zap": { "$ref": "#/definitions/config.Zap" } } }, "config.System": { "type": "object", "properties": { "addr": { "description": "端口值", "type": "integer" }, "dbType": { "description": "数据库类型:mysql(默认)|sqlite|sqlserver|postgresql", "type": "string" }, "env": { "description": "环境值", "type": "string" }, "ossType": { "description": "Oss类型", "type": "string" }, "useMultipoint": { "description": "多点登录拦截", "type": "boolean" } } }, "config.TencentCOS": { "type": "object", "properties": { "baseURL": { "type": "string" }, "bucket": { "type": "string" }, "pathPrefix": { "type": "string" }, "region": { "type": "string" }, "secretID": { "type": "string" }, "secretKey": { "type": "string" } } }, "config.Timer": { "type": "object", "properties": { "detail": { "type": "array", "items": { "$ref": "#/definitions/config.Detail" } }, "spec": { "description": "CRON表达式", "type": "string" }, "start": { "description": "是否启用", "type": "boolean" } } }, "config.Zap": { "type": "object", "properties": { "director": { "description": "日志文件夹", "type": "string" }, "encodeLevel": { "description": "编码级", "type": "string" }, "format": { "description": "输出", "type": "string" }, "level": { "description": "级别", "type": "string" }, "linkName": { "description": "软链接名称", "type": "string" }, "logInConsole": { "description": "输出控制台", "type": "boolean" }, "prefix": { "description": "日志前缀", "type": "string" }, "showLine": { "description": "显示行", "type": "boolean" }, "stacktraceKey": { "description": "栈名", "type": "string" } } }, "request.AddMenuAuthorityInfo": { "type": "object", "properties": { "authorityId": { "description": "角色ID", "type": "string" }, "menus": { "type": "array", "items": { "$ref": "#/definitions/web.SysBaseMenu" } } } }, "request.ChangePasswordStruct": { "type": "object", "properties": { "newPassword": { "description": "新密码", "type": "string" }, "password": { "description": "密码", "type": "string" }, "username": { "description": "用户名", "type": "string" } } }, "request.Empty": { "type": "object" }, "request.GetAuthorityId": { "type": "object", "properties": { "authorityId": { "description": "角色ID", "type": "string" } } }, "request.GetById": { "type": "object", "properties": { "id": { "description": "主键ID", "type": "number" } } }, "request.Login": { "type": "object", "properties": { "captcha": { "description": "验证码", "type": "string" }, "captchaId": { "description": "验证码ID", "type": "string" }, "password": { "description": "密码", "type": "string" }, "username": { "description": "用户名", "type": "string" } } }, "request.PageInfo": { "type": "object", "properties": { "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "request.Register": { "type": "object", "properties": { "authorityId": { "type": "string" }, "authorityIds": { "type": "array", "items": { "type": "string" } }, "headerImg": { "type": "string" }, "nickName": { "type": "string" }, "passWord": { "type": "string" }, "userName": { "type": "string" } } }, "request.SetUserAuth": { "type": "object", "properties": { "authorityId": { "description": "角色ID", "type": "string" } } }, "request.SetUserAuthorities": { "type": "object", "properties": { "authorityIds": { "description": "角色ID", "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" } } }, "web.SysAuthority": { "type": "object", "properties": { "authorityId": { "description": "角色ID", "type": "string" }, "authorityName": { "description": "角色名", "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/definitions/web.SysAuthority" } }, "createdAt": { "description": "创建时间", "type": "string" }, "dataAuthorityId": { "type": "array", "items": { "$ref": "#/definitions/web.SysAuthority" } }, "defaultRouter": { "description": "默认菜单(默认dashboard)", "type": "string" }, "deletedAt": { "type": "string" }, "menus": { "type": "array", "items": { "$ref": "#/definitions/web.SysBaseMenu" } }, "parentId": { "description": "父角色ID", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "web.SysBaseMenu": { "type": "object", "properties": { "authoritys": { "type": "array", "items": { "$ref": "#/definitions/web.SysAuthority" } }, "children": { "type": "array", "items": { "$ref": "#/definitions/web.SysBaseMenu" } }, "closeTab": { "description": "自动关闭tab", "type": "boolean" }, "component": { "description": "对应前端文件路径", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "defaultMenu": { "description": "是否是基础路由（开发中）", "type": "boolean" }, "hidden": { "description": "是否在列表隐藏", "type": "boolean" }, "icon": { "description": "菜单图标", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "keepAlive": { "description": "是否缓存", "type": "boolean" }, "name": { "description": "路由name", "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/web.SysBaseMenuParameter" } }, "parentId": { "description": "父菜单ID", "type": "string" }, "path": { "description": "路由path", "type": "string" }, "sort": { "description": "排序标记", "type": "integer" }, "title": { "description": "菜单名", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "web.SysBaseMenuParameter": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "key": { "description": "地址栏携带参数的key", "type": "string" }, "sysBaseMenuID": { "type": "integer" }, "type": { "description": "地址栏携带参数为params还是query", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" }, "value": { "description": "地址栏携带参数的值", "type": "string" } } }, "web.SysUser": { "type": "object", "properties": { "activeColor": { "description": "活跃颜色", "type": "string" }, "authorities": { "type": "array", "items": { "$ref": "#/definitions/web.SysAuthority" } }, "authority": { "$ref": "#/definitions/web.SysAuthority" }, "authorityId": { "description": "用户角色ID", "type": "string" }, "baseColor": { "description": "基础颜色", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "headerImg": { "description": "用户头像", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "nickName": { "description": "用户昵称", "type": "string" }, "sideMode": { "description": "用户侧边主题", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" }, "userName": { "description": "用户登录名", "type": "string" }, "uuid": { "description": "用户UUID", "type": "string" } } }, "web.System": { "type": "object", "properties": { "config": { "$ref": "#/definitions/config.Server" } } } } }` type swaggerInfo struct { Version string Host string BasePath string Schemes []string Title string Description string } // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = swaggerInfo{ Version: "", Host: "", BasePath: "", Schemes: []string{}, Title: "", Description: "", } type s struct{} func (s *s) ReadDoc() string { sInfo := SwaggerInfo sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1) t, err := template.New("swagger_info").Funcs(template.FuncMap{ "marshal": func(v interface{}) string { a, _ := json.Marshal(v) return string(a) }, "escape": func(v interface{}) string { // escape tabs str := strings.Replace(v.(string), "\t", "\\t", -1) // replace " with \", and if that results in \\", replace that with \\\" str = strings.Replace(str, "\"", "\\\"", -1) return strings.Replace(str, "\\\\\"", "\\\\\\\"", -1) }, }).Parse(doc) if err != nil { return doc } var tpl bytes.Buffer if err := t.Execute(&tpl, sInfo); err != nil { return doc } return tpl.String() } func init() { swag.Register("swagger", &s{}) }