|
|
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag
package docs
import ( "bytes" "encoding/json" "strings"
"github.com/alecthomas/template" "github.com/swaggo/swag")
var doc = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{.Description}}", "title": "{{.Title}}", "contact": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/api/createApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "创建基础api", "parameters": [ { "description": "api路径, api中文描述, api组, 方法", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysApi" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } } }, "/api/deleteApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "删除api", "parameters": [ { "description": "ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysApi" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/api/deleteApisByIds": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "删除选中Api", "parameters": [ { "description": "ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.IdsReq" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/api/getAllApis": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "获取所有的Api 不分页", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/getApiById": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "根据id获取api", "parameters": [ { "description": "根据id获取api", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetById" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/getApiList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "分页获取API列表", "parameters": [ { "description": "分页获取API列表", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.SearchApiParams" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/updateApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "创建基础api", "parameters": [ { "description": "api路径, api中文描述, api组, 方法", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysApi" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}", "schema": { "type": "string" } } } } }, "/authority/copyAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authority" ], "summary": "拷贝角色", "parameters": [ { "description": "旧角色id, 新权限id, 新权限名, 新父角色id", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/response.SysAuthorityCopyResponse" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"拷贝成功\"}", "schema": { "type": "string" } } } } }, "/authority/createAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authority" ], "summary": "创建角色", "parameters": [ { "description": "权限id, 权限名, 父角色id", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysAuthority" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } } }, "/authority/deleteAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authority" ], "summary": "删除角色", "parameters": [ { "description": "删除角色", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysAuthority" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/authority/getAuthorityList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authority" ], "summary": "分页获取角色列表", "parameters": [ { "description": "页码, 每页大小", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/authority/setDataAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authority" ], "summary": "设置角色资源权限", "parameters": [ { "description": "设置角色资源权限", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysAuthority" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"设置成功\"}", "schema": { "type": "string" } } } } }, "/authority/updateAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Authority" ], "summary": "更新角色信息", "parameters": [ { "description": "权限id, 权限名, 父角色id", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysAuthority" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/createTemp": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "自动代码模板", "parameters": [ { "description": "创建自动代码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.AutoCodeStruct" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/delSysHistory": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "删除回滚记录", "parameters": [ { "description": "删除回滚记录", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.AutoHistoryByID" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/getColumn": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "获取当前表所有字段", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/getDatabase": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "获取当前所有数据库", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/getMeta": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "回滚", "parameters": [ { "description": "获取meta信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.AutoHistoryByID" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/getSysHistory": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "查询回滚记录", "parameters": [ { "description": "查询回滚记录", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.SysAutoHistory" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/getTables": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "获取当前数据库所有表", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/preview": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "预览创建后的代码", "parameters": [ { "description": "预览创建代码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.AutoCodeStruct" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } } }, "/autoCode/rollback": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCode" ], "summary": "回滚", "parameters": [ { "description": "回滚自动生成代码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.AutoHistoryByID" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"回滚成功\"}", "schema": { "type": "string" } } } } }, "/autoCodeExample/createAutoCodeExample": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCodeExample" ], "summary": "创建AutoCodeExample", "parameters": [ { "description": "AutoCodeExample模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/autocode.AutoCodeExample" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } } }, "/autoCodeExample/deleteAutoCodeExample": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCodeExample" ], "summary": "删除AutoCodeExample", "parameters": [ { "description": "AutoCodeExample模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/autocode.AutoCodeExample" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/autoCodeExample/findAutoCodeExample": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCodeExample" ], "summary": "用id查询AutoCodeExample", "parameters": [ { "type": "string", "description": "展示值", "name": "autoCodeExampleField", "in": "query" }, { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"查询成功\"}", "schema": { "type": "string" } } } } }, "/autoCodeExample/getAutoCodeExampleList": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCodeExample" ], "summary": "分页获取AutoCodeExample列表", "parameters": [ { "type": "string", "description": "展示值", "name": "autoCodeExampleField", "in": "query" }, { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页大小", "name": "pageSize", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/autoCodeExample/updateAutoCodeExample": { "put": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "AutoCodeExample" ], "summary": "更新AutoCodeExample", "parameters": [ { "description": "更新AutoCodeExample", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/autocode.AutoCodeExample" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } } }, "/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" } } } } }, "/casbin/UpdateCasbin": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Casbin" ], "summary": "更新角色api权限", "parameters": [ { "description": "权限id, 权限模型列表", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.CasbinInReceive" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } } }, "/casbin/getPolicyPathByAuthorityId": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Casbin" ], "summary": "获取权限列表", "parameters": [ { "description": "权限id, 权限模型列表", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.CasbinInReceive" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/customer/customer": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ExaCustomer" ], "summary": "获取单一客户信息", "parameters": [ { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "string", "description": "客户名", "name": "customerName", "in": "query" }, { "type": "string", "description": "客户手机号", "name": "customerPhoneData", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "管理角色ID", "name": "sysUserAuthorityID", "in": "query" }, { "type": "integer", "description": "管理ID", "name": "sysUserId", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ExaCustomer" ], "summary": "更新客户信息", "parameters": [ { "description": "客户ID, 客户信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/example.ExaCustomer" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ExaCustomer" ], "summary": "创建客户", "parameters": [ { "description": "客户用户名, 客户手机号码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/example.ExaCustomer" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ExaCustomer" ], "summary": "删除客户", "parameters": [ { "description": "客户ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/example.ExaCustomer" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/customer/customerList": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ExaCustomer" ], "summary": "分页获取权限客户列表", "parameters": [ { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页大小", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/email/emailTest": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "System" ], "summary": "发送测试邮件", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"发送成功\"}", "schema": { "type": "string" } } } } }, "/email/sendEmail": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "System" ], "summary": "发送邮件", "parameters": [ { "description": "发送邮件必须的参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/response.Email" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"发送成功\"}", "schema": { "type": "string" } } } } }, "/excel/downloadTemplate": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "excel" ], "summary": "下载模板", "parameters": [ { "type": "string", "description": "模板名称", "name": "fileName", "in": "query", "required": true } ], "responses": { "200": { "description": "" } } } }, "/excel/exportExcel": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "excel" ], "summary": "导出Excel", "parameters": [ { "description": "导出Excel文件信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/example.ExcelInfo" } } ], "responses": { "200": { "description": "" } } } }, "/excel/importExcel": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "excel" ], "summary": "导入Excel文件", "parameters": [ { "type": "file", "description": "导入Excel文件", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"导入成功\"}", "schema": { "type": "string" } } } } }, "/excel/loadExcel": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "excel" ], "summary": "加载Excel数据", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"加载数据成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/breakpointContinue": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "ExaFileUploadAndDownload" ], "summary": "断点续传到服务器", "parameters": [ { "type": "file", "description": "an example for breakpoint resume, 断点续传示例", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"切片创建成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/deleteFile": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "ExaFileUploadAndDownload" ], "summary": "删除文件", "parameters": [ { "description": "传入文件里面id即可", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/example.ExaFileUploadAndDownload" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/findFile": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "ExaFileUploadAndDownload" ], "summary": "创建文件", "parameters": [ { "type": "file", "description": "上传文件完成", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"file uploaded, 文件创建成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/getFileList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ExaFileUploadAndDownload" ], "summary": "分页文件列表", "parameters": [ { "description": "页码, 每页大小", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/removeChunk": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "ExaFileUploadAndDownload" ], "summary": "删除切片", "parameters": [ { "type": "file", "description": "删除缓存切片", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"缓存切片删除成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/upload": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "ExaFileUploadAndDownload" ], "summary": "上传文件示例", "parameters": [ { "type": "file", "description": "上传文件示例", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"上传成功\"}", "schema": { "type": "string" } } } } }, "/init/checkdb": { "post": { "produces": [ "application/json" ], "tags": [ "CheckDB" ], "summary": "初始化用户数据库", "responses": { "200": { "description": "{\"code\":0,\"data\":{},\"msg\":\"探测完成\"}", "schema": { "type": "string" } } } } }, "/init/initdb": { "post": { "produces": [ "application/json" ], "tags": [ "InitDB" ], "summary": "初始化用户数据库", "parameters": [ { "description": "初始化数据库参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.InitDB" } } ], "responses": { "200": { "description": "{\"code\":0,\"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/system.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/system.SysBaseMenu" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionary/createSysDictionary": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "创建SysDictionary", "parameters": [ { "description": "SysDictionary模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionary/deleteSysDictionary": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "删除SysDictionary", "parameters": [ { "description": "SysDictionary模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionary/findSysDictionary": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "用id查询SysDictionary", "parameters": [ { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "string", "description": "描述", "name": "desc", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "字典名（中）", "name": "name", "in": "query" }, { "type": "boolean", "description": "状态", "name": "status", "in": "query" }, { "type": "string", "description": "字典名（英）", "name": "type", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"查询成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionary/getSysDictionaryList": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "分页获取SysDictionary列表", "parameters": [ { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "string", "description": "描述", "name": "desc", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "字典名（中）", "name": "name", "in": "query" }, { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页大小", "name": "pageSize", "in": "query" }, { "type": "boolean", "description": "状态", "name": "status", "in": "query" }, { "type": "string", "description": "字典名（英）", "name": "type", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionary/updateSysDictionary": { "put": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "更新SysDictionary", "parameters": [ { "description": "SysDictionary模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionaryDetail/createSysDictionaryDetail": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "创建SysDictionaryDetail", "parameters": [ { "description": "SysDictionaryDetail模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionaryDetail" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionaryDetail/deleteSysDictionaryDetail": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "删除SysDictionaryDetail", "parameters": [ { "description": "SysDictionaryDetail模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionaryDetail" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionaryDetail/findSysDictionaryDetail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "用id查询SysDictionaryDetail", "parameters": [ { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "展示值", "name": "label", "in": "query" }, { "type": "integer", "description": "排序标记", "name": "sort", "in": "query" }, { "type": "boolean", "description": "启用状态", "name": "status", "in": "query" }, { "type": "integer", "description": "关联标记", "name": "sysDictionaryID", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" }, { "type": "integer", "description": "字典值", "name": "value", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"查询成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionaryDetail/getSysDictionaryDetailList": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "分页获取SysDictionaryDetail列表", "parameters": [ { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "展示值", "name": "label", "in": "query" }, { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页大小", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "排序标记", "name": "sort", "in": "query" }, { "type": "boolean", "description": "启用状态", "name": "status", "in": "query" }, { "type": "integer", "description": "关联标记", "name": "sysDictionaryID", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" }, { "type": "integer", "description": "字典值", "name": "value", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/sysDictionaryDetail/updateSysDictionaryDetail": { "put": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "更新SysDictionaryDetail", "parameters": [ { "description": "更新SysDictionaryDetail", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionaryDetail" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}", "schema": { "type": "string" } } } } }, "/sysOperationRecord/createSysOperationRecord": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysOperationRecord" ], "summary": "创建SysOperationRecord", "parameters": [ { "description": "创建SysOperationRecord", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysOperationRecord" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/sysOperationRecord/deleteSysOperationRecord": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysOperationRecord" ], "summary": "删除SysOperationRecord", "parameters": [ { "description": "SysOperationRecord模型", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysOperationRecord" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}", "schema": { "type": "string" } } } } }, "/sysOperationRecord/deleteSysOperationRecordByIds": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysOperationRecord" ], "summary": "批量删除SysOperationRecord", "parameters": [ { "description": "批量删除SysOperationRecord", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.IdsReq" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"批量删除成功\"}", "schema": { "type": "string" } } } } }, "/sysOperationRecord/findSysOperationRecord": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysOperationRecord" ], "summary": "用id查询SysOperationRecord", "parameters": [ { "type": "string", "description": "代理", "name": "agent", "in": "query" }, { "type": "string", "description": "请求Body", "name": "body", "in": "query" }, { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "string", "description": "错误信息", "name": "error_message", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "请求ip", "name": "ip", "in": "query" }, { "type": "string", "description": "延迟", "name": "latency", "in": "query" }, { "type": "string", "description": "请求方法", "name": "method", "in": "query" }, { "type": "string", "description": "请求路径", "name": "path", "in": "query" }, { "type": "string", "description": "响应Body", "name": "resp", "in": "query" }, { "type": "integer", "description": "请求状态", "name": "status", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" }, { "type": "integer", "description": "用户id", "name": "user_id", "in": "query" } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"查询成功\"}", "schema": { "type": "string" } } } } }, "/sysOperationRecord/getSysOperationRecordList": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysOperationRecord" ], "summary": "分页获取SysOperationRecord列表", "parameters": [ { "type": "string", "description": "代理", "name": "agent", "in": "query" }, { "type": "string", "description": "请求Body", "name": "body", "in": "query" }, { "type": "string", "description": "创建时间", "name": "createdAt", "in": "query" }, { "type": "string", "description": "错误信息", "name": "error_message", "in": "query" }, { "type": "integer", "description": "主键ID", "name": "id", "in": "query" }, { "type": "string", "description": "请求ip", "name": "ip", "in": "query" }, { "type": "string", "description": "延迟", "name": "latency", "in": "query" }, { "type": "string", "description": "请求方法", "name": "method", "in": "query" }, { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页大小", "name": "pageSize", "in": "query" }, { "type": "string", "description": "请求路径", "name": "path", "in": "query" }, { "type": "string", "description": "响应Body", "name": "resp", "in": "query" }, { "type": "integer", "description": "请求状态", "name": "status", "in": "query" }, { "type": "string", "description": "更新时间", "name": "updatedAt", "in": "query" }, { "type": "integer", "description": "用户id", "name": "user_id", "in": "query" } ], "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/system.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/system.SysUser" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"设置成功\"}", "schema": { "type": "string" } } } } } }, "definitions": { "autocode.AutoCodeExample": { "type": "object", "properties": { "autoCodeExampleField": { "description": "展示值", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "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" }, "webFlow": { "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" } } }, "example.ExaCustomer": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "customerName": { "description": "客户名", "type": "string" }, "customerPhoneData": { "description": "客户手机号", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "sysUser": { "description": "管理详情", "$ref": "#/definitions/system.SysUser" }, "sysUserAuthorityID": { "description": "管理角色ID", "type": "string" }, "sysUserId": { "description": "管理ID", "type": "integer" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "example.ExaFileUploadAndDownload": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "key": { "description": "编号", "type": "string" }, "name": { "description": "文件名", "type": "string" }, "tag": { "description": "文件标签", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" }, "url": { "description": "文件地址", "type": "string" } } }, "example.ExcelInfo": { "type": "object", "properties": { "fileName": { "description": "文件名", "type": "string" }, "infoList": { "type": "array", "items": { "$ref": "#/definitions/system.SysBaseMenu" } } } }, "request.AddMenuAuthorityInfo": { "type": "object", "properties": { "authorityId": { "description": "角色ID", "type": "string" }, "menus": { "type": "array", "items": { "$ref": "#/definitions/system.SysBaseMenu" } } } }, "request.AutoHistoryByID": { "type": "object", "properties": { "id": { "type": "integer" } } }, "request.CasbinInReceive": { "type": "object", "properties": { "authorityId": { "description": "权限id", "type": "string" }, "casbinInfos": { "type": "array", "items": { "$ref": "#/definitions/request.CasbinInfo" } } } }, "request.CasbinInfo": { "type": "object", "properties": { "method": { "description": "方法", "type": "string" }, "path": { "description": "路径", "type": "string" } } }, "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.IdsReq": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" } } } }, "request.InitDB": { "type": "object", "required": [ "dbName", "userName" ], "properties": { "dbName": { "description": "数据库名", "type": "string" }, "host": { "description": "服务器地址", "type": "string" }, "password": { "description": "数据库密码", "type": "string" }, "port": { "description": "数据库连接端口", "type": "string" }, "userName": { "description": "数据库用户名", "type": "string" } } }, "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.SearchApiParams": { "type": "object", "properties": { "apiGroup": { "description": "api组", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "排序方式:升序false(默认)|降序true", "type": "boolean" }, "description": { "description": "api中文描述", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "method": { "description": "方法:创建POST(默认)|查看GET|更新PUT|删除DELETE", "type": "string" }, "orderKey": { "description": "排序", "type": "string" }, "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "path": { "description": "api路径", "type": "string" }, "updatedAt": { "description": "更新时间", "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" } } }, "request.SysAutoHistory": { "type": "object", "properties": { "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "response.Email": { "type": "object", "properties": { "body": { "description": "邮件内容", "type": "string" }, "subject": { "description": "邮件标题", "type": "string" }, "to": { "description": "邮件发送给谁", "type": "string" } } }, "response.SysAuthorityCopyResponse": { "type": "object", "properties": { "authority": { "$ref": "#/definitions/system.SysAuthority" }, "oldAuthorityId": { "description": "旧角色ID", "type": "string" } } }, "system.AutoCodeStruct": { "type": "object", "properties": { "abbreviation": { "description": "Struct简称", "type": "string" }, "autoCreateApiToSql": { "description": "是否自动创建api", "type": "boolean" }, "autoMoveFile": { "description": "是否自动移动文件", "type": "boolean" }, "description": { "description": "Struct中文名称", "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/system.Field" } }, "humpPackageName": { "description": "go文件名称", "type": "string" }, "packageName": { "description": "文件名称", "type": "string" }, "structName": { "description": "Struct名称", "type": "string" }, "tableName": { "description": "表名", "type": "string" } } }, "system.Field": { "type": "object", "properties": { "columnName": { "description": "数据库字段", "type": "string" }, "comment": { "description": "数据库字段描述", "type": "string" }, "dataType": { "description": "数据库字段类型", "type": "string" }, "dataTypeLong": { "description": "数据库字段长度", "type": "string" }, "dictType": { "description": "字典", "type": "string" }, "fieldDesc": { "description": "中文名", "type": "string" }, "fieldJson": { "description": "FieldJson", "type": "string" }, "fieldName": { "description": "Field名", "type": "string" }, "fieldSearchType": { "description": "搜索条件", "type": "string" }, "fieldType": { "description": "Field数据类型", "type": "string" } } }, "system.SysApi": { "type": "object", "properties": { "apiGroup": { "description": "api组", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "description": { "description": "api中文描述", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "method": { "description": "方法:创建POST(默认)|查看GET|更新PUT|删除DELETE", "type": "string" }, "path": { "description": "api路径", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "system.SysAuthority": { "type": "object", "properties": { "authorityId": { "description": "角色ID", "type": "string" }, "authorityName": { "description": "角色名", "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/definitions/system.SysAuthority" } }, "createdAt": { "description": "创建时间", "type": "string" }, "dataAuthorityId": { "type": "array", "items": { "$ref": "#/definitions/system.SysAuthority" } }, "defaultRouter": { "description": "默认菜单(默认dashboard)", "type": "string" }, "deletedAt": { "type": "string" }, "menus": { "type": "array", "items": { "$ref": "#/definitions/system.SysBaseMenu" } }, "parentId": { "description": "父角色ID", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "system.SysBaseMenu": { "type": "object", "properties": { "authoritys": { "type": "array", "items": { "$ref": "#/definitions/system.SysAuthority" } }, "children": { "type": "array", "items": { "$ref": "#/definitions/system.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/system.SysBaseMenuParameter" } }, "parentId": { "description": "父菜单ID", "type": "string" }, "path": { "description": "路由path", "type": "string" }, "sort": { "description": "排序标记", "type": "integer" }, "title": { "description": "菜单名", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "system.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" } } }, "system.SysDictionary": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "描述", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "name": { "description": "字典名（中）", "type": "string" }, "status": { "description": "状态", "type": "boolean" }, "sysDictionaryDetails": { "type": "array", "items": { "$ref": "#/definitions/system.SysDictionaryDetail" } }, "type": { "description": "字典名（英）", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "system.SysDictionaryDetail": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "label": { "description": "展示值", "type": "string" }, "sort": { "description": "排序标记", "type": "integer" }, "status": { "description": "启用状态", "type": "boolean" }, "sysDictionaryID": { "description": "关联标记", "type": "integer" }, "updatedAt": { "description": "更新时间", "type": "string" }, "value": { "description": "字典值", "type": "integer" } } }, "system.SysOperationRecord": { "type": "object", "properties": { "agent": { "description": "代理", "type": "string" }, "body": { "description": "请求Body", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "error_message": { "description": "错误信息", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "ip": { "description": "请求ip", "type": "string" }, "latency": { "description": "延迟", "type": "string" }, "method": { "description": "请求方法", "type": "string" }, "path": { "description": "请求路径", "type": "string" }, "resp": { "description": "响应Body", "type": "string" }, "status": { "description": "请求状态", "type": "integer" }, "updatedAt": { "description": "更新时间", "type": "string" }, "user": { "$ref": "#/definitions/system.SysUser" }, "user_id": { "description": "用户id", "type": "integer" } } }, "system.SysUser": { "type": "object", "properties": { "activeColor": { "description": "活跃颜色", "type": "string" }, "authorities": { "type": "array", "items": { "$ref": "#/definitions/system.SysAuthority" } }, "authority": { "$ref": "#/definitions/system.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" } } }, "system.System": { "type": "object", "properties": { "config": { "$ref": "#/definitions/config.Server" } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "name": "x-token", "in": "header" } }}`
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: "0.0.1", Host: "", BasePath: "/", Schemes: []string{}, Title: "Swagger Example API", Description: "This is a sample Server pets",}
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) }, }).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(swag.Name, &s{})}
|
