{ "swagger": "2.0", "info": { "description": "使用 gin + vue 进行开发的全栈开发基础平台", "title": "Go-Vue-Admin Swagger API接口文档", "contact": {}, "version": "v1.0.0" }, "paths": { "/api/createApi": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "创建 api", "parameters": [ { "description": "创建 api", "name": "createApiInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/github_com_shansec_go-vue-admin_model_system.SysApi" } } ], "responses": { "200": { "description": "创建成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "服务器内部错误", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/api/deleteApi": { "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "删除 api", "parameters": [ { "description": "删除 api", "name": "deleteApiInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/github_com_shansec_go-vue-admin_model_system.SysApi" } } ], "responses": { "200": { "description": "删除成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "服务器内部错误", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/api/getApiList": { "post": { "description": "分页查询 api 信息列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "获取 api 列表", "parameters": [ { "description": "api 列表查询参数", "name": "apiPageInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetApiList" } } ], "responses": { "200": { "description": "api 列表获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.PageResult" }, { "type": "object", "properties": { " msg": { "type": "string" }, "list": { "type": "array", "items": { "$ref": "#/definitions/github_com_shansec_go-vue-admin_model_system.SysApi" } } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取部门列表失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/api/updateApi": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysApi" ], "summary": "更新 api", "parameters": [ { "description": "更新 api", "name": "updateApiInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/github_com_shansec_go-vue-admin_model_system.SysApi" } } ], "responses": { "200": { "description": "更新成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "服务器内部错误", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/autocode/createCode": { "post": { "description": "创建代码", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysAutoCode" ], "summary": "创建代码", "parameters": [ { "description": "创建代码", "name": "autoCode", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.AutoCodeStruct" } } ], "responses": { "200": { "description": "创建代码，返回结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "创建代码失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/autocode/createPackage": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysAutoCode" ], "summary": "自动创建代码包", "parameters": [ { "description": "自动创建代码包", "name": "autoCode", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysAutoCode" } } ], "responses": { "200": { "description": "创建成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "服务器内部错误", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/autocode/delPackageInfo": { "delete": { "description": "删除指定的创建的包信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysAutoCode" ], "summary": "删除创建的包信息", "parameters": [ { "description": "待删除的创建的包信息", "name": "autoCode", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysAutoCode" } } ], "responses": { "200": { "description": "删除创建的包，返回操作结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "删除创建的包失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/autocode/getPackageList": { "post": { "description": "分页查询创建的包列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysAutoCode" ], "summary": "获取创建的包列表", "parameters": [ { "description": "创建的包列表查询参数", "name": "packageInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetPackageList" } } ], "responses": { "200": { "description": "获取创建的包列表成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.PageResult" }, { "type": "object", "properties": { " msg": { "type": "string" }, "list": { "type": "array", "items": { "$ref": "#/definitions/system.SysAutoCode" } } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取创建的包列表失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/autocode/previewCode": { "post": { "description": "预览代码", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysAutoCode" ], "summary": "预览代码", "parameters": [ { "description": "预览代码", "name": "autocode", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.AutoCodeStruct" } } ], "responses": { "200": { "description": "预览代码，返回结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "预览代码失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/base/captcha": { "get": { "description": "生成并返回一个新的默认数字验证码", "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "获取验证码", "responses": { "200": { "description": "获取验证码", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.SysCaptchaResponse" } } } ] } }, "500": { "description": "验证码获取失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/base/login": { "post": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "用户登录", "parameters": [ { "description": "用户登录", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.Login" } } ], "responses": { "200": { "description": "用户登录", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.Login" } } } ] } } } } }, "/dept/createDept": { "post": { "description": "添加部门，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysDept" ], "summary": "添加部门", "parameters": [ { "description": "添加部门", "name": "deptInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.Create" } } ], "responses": { "200": { "description": "添加部门,返回添加结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "500": { "description": "添加部门失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dept/delDeptInfo": { "delete": { "description": "删除指定的部门及其所有下级部门信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDept" ], "summary": "删除部门信息", "parameters": [ { "description": "待删除的部门信息", "name": "deptInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDept" } } ], "responses": { "200": { "description": "删除部门信息，返回操作结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "删除部门信息失败,请检查是否包含下级部门", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dept/getDeptList": { "post": { "description": "分页查询部门信息列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDept" ], "summary": "获取部门列表", "parameters": [ { "description": "部门列表查询参数", "name": "deptPageInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetDeptList" } } ], "responses": { "200": { "description": "获取部门列表成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.PageResult" }, { "type": "object", "properties": { " msg": { "type": "string" }, "list": { "type": "array", "items": { "$ref": "#/definitions/system.SysDept" } } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取部门列表失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dept/updateDeptInfo": { "put": { "description": "更新指定部门的详细信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SysDept" ], "summary": "更新部门信息", "parameters": [ { "description": "待更新的部门信息", "name": "dept", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDept" } } ], "responses": { "200": { "description": "更新部门信息,返回更新结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "更改部门信息失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionary/createDictionary": { "post": { "description": "添加字典，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "添加字典", "parameters": [ { "description": "添加字典", "name": "dictionaryInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "添加字典,返回添加结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "添加字典失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionary/deleteDictionary": { "delete": { "description": "删除字典，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "删除字典", "parameters": [ { "description": "删除字典", "name": "dictionaryInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "删除字典,返回删除结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "删除字典失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionary/getDictionary": { "post": { "description": "获取字典详情", "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "获取字典详情", "parameters": [ { "description": "获取字典详情", "name": "dictionaryInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "获取字典详情", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/system.SysDictionary" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取字典详情失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionary/getDictionaryInfoList": { "post": { "description": "分页获取字典", "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "分页获取字典", "parameters": [ { "description": "分页获取字典", "name": "dictionaryInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "分页获取字典", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/system.SysDictionary" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "分页获取字典失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionary/updateDictionary": { "put": { "description": "修改字典，返回修改结果", "produces": [ "application/json" ], "tags": [ "SysDictionary" ], "summary": "修改字典", "parameters": [ { "description": "修改字典", "name": "dictionaryInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionary" } } ], "responses": { "200": { "description": "修改字典,返回修改结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "修改字典失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionaryDetail/createDictionaryDetail": { "post": { "description": "添加字典详情，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "添加字典详情", "parameters": [ { "description": "添加字典详情", "name": "dictionaryDetailInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionaryDetail" } } ], "responses": { "200": { "description": "添加字典详情,返回添加结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "添加字典详情失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionaryDetail/deleteDictionaryDetail": { "delete": { "description": "删除字典详情，返回删除结果", "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "删除字典详情", "parameters": [ { "description": "删除字典详情", "name": "dictionaryDetailInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionaryDetail" } } ], "responses": { "200": { "description": "删除字典详情,返回删除结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "删除字典详情失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionaryDetail/getDictionaryDetail": { "post": { "description": "获取字典详情", "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "获取字典详情", "parameters": [ { "description": "获取字典详情", "name": "dictionaryDetailInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionaryDetail" } } ], "responses": { "200": { "description": "获取字典详情", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/system.SysDictionaryDetail" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取字典详情失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionaryDetail/getDictionaryDetailList": { "post": { "description": "分页获取字典详情", "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "分页获取字典详情", "parameters": [ { "description": "分页获取字典详情", "name": "pageInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.SysDictionaryDetailSearch" } } ], "responses": { "200": { "description": "分页获取字典详情", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.PageResult" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "分页获取字典详情失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/dictionaryDetail/updateDictionaryDetail": { "put": { "description": "修改字典详情，返回修改结果", "produces": [ "application/json" ], "tags": [ "SysDictionaryDetail" ], "summary": "修改字典详情", "parameters": [ { "description": "修改字典详情", "name": "dictionaryDetailInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysDictionaryDetail" } } ], "responses": { "200": { "description": "修改字典详情,返回修改结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "修改字典详情失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/init/checkDB": { "post": { "description": "检查是否已初始化", "tags": [ "InitDB" ], "summary": "检查是否已初始化", "responses": {} } }, "/init/initDB": { "post": { "description": "初始化系统数据", "tags": [ "InitDB" ], "summary": "初始化数据", "responses": { "200": { "description": "初始化系统数据", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "参数错误", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "初始化失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/menu/createMenu": { "post": { "description": "添加菜单，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysBaseMenu" ], "summary": "添加菜单", "parameters": [ { "description": "添加菜单", "name": "menuInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysBaseMenu" } } ], "responses": { "200": { "description": "添加菜单,返回添加结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.SysMenuResponse" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "添加菜单失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/menu/deleteMenu": { "delete": { "description": "删除菜单，返回操作结果", "produces": [ "application/json" ], "tags": [ "SysBaseMenu" ], "summary": "删除菜单", "parameters": [ { "description": "删除菜单", "name": "menuInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysBaseMenu" } } ], "responses": { "200": { "description": "删除菜单,返回操作结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "删除菜单失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/menu/getMenuList": { "post": { "description": "分页获取菜单", "produces": [ "application/json" ], "tags": [ "SysBaseMenu" ], "summary": "分页获取菜单", "parameters": [ { "description": "分页获取菜单", "name": "pageInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.PageInfo" } } ], "responses": { "200": { "description": "分页获取菜单", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.PageResult" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "分页获取菜单失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/menu/getMenuTree": { "post": { "description": "获取树状菜单", "produces": [ "application/json" ], "tags": [ "SysBaseMenu" ], "summary": "获取树状菜单", "responses": { "200": { "description": "获取树状菜单", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.NoPageResult" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取树状菜单失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/menu/getRoleMenu": { "post": { "description": "获取当前登录角色菜单", "produces": [ "application/json" ], "tags": [ "SysBaseMenu" ], "summary": "获取当前登录角色菜单", "responses": { "200": { "description": "获取当前登录角色菜单", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.NoPageResult" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取当前登录角色菜单失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/menu/getSpecialRoleMenu": { "post": { "description": "获取指定角色菜单", "produces": [ "application/json" ], "tags": [ "SysBaseMenu" ], "summary": "获取指定角色菜单", "responses": { "200": { "description": "获取指定角色菜单", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.NoPageResult" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "获取指定角色菜单失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/menu/updateMenu": { "put": { "description": "修改菜单，返回操作结果", "produces": [ "application/json" ], "tags": [ "SysBaseMenu" ], "summary": "修改菜单", "parameters": [ { "description": "修改菜单", "name": "menuInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysBaseMenu" } } ], "responses": { "200": { "description": "修改菜单,返回操作结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "修改菜单失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/role/addRoleMenu": { "post": { "description": "角色设置菜单权限", "produces": [ "application/json" ], "tags": [ "SysRole" ], "summary": "角色设置菜单权限", "parameters": [ { "description": "角色设置菜单权限", "name": "info", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.MenuRoleInfo" } } ], "responses": { "200": { "description": "角色设置菜单权限", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "角色设置菜单权限失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/role/createRole": { "post": { "description": "添加角色，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysRole" ], "summary": "添加角色", "parameters": [ { "description": "添加角色", "name": "createRoleInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysRole" } } ], "responses": { "200": { "description": "添加角色,返回添加结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.SysRoleResponse" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "添加角色失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/role/deleteRole": { "delete": { "description": "删除角色，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysRole" ], "summary": "删除角色", "parameters": [ { "description": "删除角色", "name": "delRoleInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysRole" } } ], "responses": { "200": { "description": "删除角色,返回添加结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "删除角色失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/role/getRoleList": { "post": { "description": "分页获取角色列表", "produces": [ "application/json" ], "tags": [ "SysRole" ], "summary": "分页获取角色列表", "parameters": [ { "description": "分页获取角色列表", "name": "pageInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.PageInfo" } } ], "responses": { "200": { "description": "分页获取角色列表", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.PageResult" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "分页获取角色列表失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/role/setChildRole": { "post": { "description": "设置子角色", "produces": [ "application/json" ], "tags": [ "SysRole" ], "summary": "设置子角色", "parameters": [ { "description": "设置子角色", "name": "role", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysRole" } } ], "responses": { "200": { "description": "设置子角色", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "设置子角色失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/role/updateRole": { "put": { "description": "更新角色，返回添加结果", "produces": [ "application/json" ], "tags": [ "SysRole" ], "summary": "更新角色", "parameters": [ { "description": "更新角色", "name": "updateRole", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysRole" } } ], "responses": { "200": { "description": "更新角色,返回添加结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.SysRoleResponse" } } } ] } }, "400": { "description": "请求参数验证失败", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "更新角色失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/system/status": { "get": { "description": "查询并返回系统的服务器相关信息", "produces": [ "application/json" ], "tags": [ "System" ], "summary": "获取服务器信息", "responses": { "200": { "description": "获取服务器信息", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } }, "500": { "description": "获取失败", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/user/delUserInfo": { "delete": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "删除用户信息", "parameters": [ { "description": "删除用户信息", "name": "data", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "删除用户信息，返回操作结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } } } } }, "/user/getUserInfo": { "get": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "获取用户信息", "responses": { "200": { "description": "获取用户信息", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.SysUserResponse" } } } ] } } } } }, "/user/getUsersInfo": { "post": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "获取用户列表", "parameters": [ { "description": "获取用户列表", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.GetUserList" } } ], "responses": { "200": { "description": "获取用户列表", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.PageResult" } } } ] } } } } }, "/user/modifyPassword": { "post": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "修改密码", "parameters": [ { "description": "修改密码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.ChangePassword" } } ], "responses": { "200": { "description": "修改密码,返回修改结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } } } } }, "/user/register": { "post": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "用户注册账号", "parameters": [ { "description": "用户注册", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/request.Register" } } ], "responses": { "200": { "description": "用户注册", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { " msg": { "type": "string" }, "data": { "$ref": "#/definitions/response.SysUserResponse" } } } ] } } } } }, "/user/updateUserInfo": { "post": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "更新用户信息", "parameters": [ { "description": "更新用户信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/system.SysUser" } } ], "responses": { "200": { "description": "更新用户信息，返回操作结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } } } } }, "/user/updateUserStatus": { "put": { "produces": [ "application/json" ], "tags": [ "SysUser" ], "summary": "更改用户状态", "parameters": [ { "description": "更改用户状态", "name": "data", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "更改用户状态，返回操作结果", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "msg": { "type": "string" } } } ] } } } } } }, "definitions": { "github_com_shansec_go-vue-admin_model_system.SysApi": { "type": "object", "properties": { "apiGroup": { "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "description": { "type": "string" }, "id": { "description": "主键 ID", "type": "integer" }, "method": { "type": "string" }, "path": { "type": "string" }, "updatedAt": { "type": "string" } } }, "request.ChangePassword": { "type": "object", "properties": { "newPassword": { "description": "新密码", "type": "string" }, "password": { "description": "旧密码", "type": "string" }, "uid": { "description": "user.id", "type": "integer" } } }, "request.Create": { "type": "object", "properties": { "deptName": { "type": "string" }, "deptPath": { "type": "string" }, "email": { "type": "string" }, "leader": { "type": "string" }, "parentId": { "type": "integer" }, "phone": { "type": "string" }, "sort": { "type": "integer" }, "status": { "type": "string" } } }, "request.GetApiList": { "type": "object", "properties": { "apiGroup": { "type": "string" }, "description": { "type": "string" }, "method": { "type": "string" }, "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "path": { "type": "string" } } }, "request.GetDeptList": { "type": "object", "properties": { "deptName": { "description": "用户昵称 \t// 用户手机号", "type": "string" }, "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "status": { "description": "用户状态", "type": "string" } } }, "request.GetPackageList": { "type": "object", "properties": { "package_name": { "description": "包名", "type": "string" }, "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "request.GetUserList": { "type": "object", "properties": { "nickName": { "description": "用户昵称", "type": "string" }, "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "phone": { "description": "用户手机号", "type": "string" }, "status": { "description": "用户状态", "type": "string" } } }, "request.Login": { "type": "object", "properties": { "captcha": { "description": "验证码", "type": "string" }, "captchaId": { "description": "验证码ID", "type": "string" }, "isPhoneLogin": { "description": "是否通过手机号登录", "type": "boolean" }, "password": { "description": "密码", "type": "string" }, "phone": { "description": "手机号", "type": "string" }, "username": { "description": "用户名", "type": "string" } } }, "request.MenuRoleInfo": { "type": "object", "properties": { "menus": { "type": "array", "items": { "$ref": "#/definitions/system.SysBaseMenu" } }, "roleId": { "type": "integer" } } }, "request.PageInfo": { "type": "object", "properties": { "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "request.Register": { "type": "object", "properties": { "deptsId": { "description": "部门ID", "type": "integer" }, "email": { "description": "用户邮箱", "type": "string" }, "headerImg": { "description": "用户头像", "type": "string" }, "nickName": { "description": "用户昵称", "type": "string" }, "password": { "description": "用户登录密码", "type": "string" }, "phone": { "description": "用户手机号", "type": "string" }, "rolesId": { "description": "用户角色ID", "type": "integer" }, "sex": { "description": "用户性别", "type": "integer" }, "status": { "description": "用户状态", "type": "integer" }, "sysDept": { "$ref": "#/definitions/system.SysDept" }, "sysRole": { "$ref": "#/definitions/system.SysRole" }, "username": { "description": "用户登录名", "type": "string" } } }, "request.SysDictionaryDetailSearch": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "extend": { "type": "string" }, "id": { "description": "主键 ID", "type": "integer" }, "label": { "type": "string" }, "page": { "description": "页码", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "sort": { "type": "integer" }, "status": { "type": "boolean" }, "sysDictionaryID": { "type": "integer" }, "updatedAt": { "type": "string" }, "value": { "type": "string" } } }, "response.Login": { "type": "object", "properties": { "expiresAt": { "type": "integer" }, "token": { "type": "string" }, "user": { "$ref": "#/definitions/system.SysUser" } } }, "response.NoPageResult": { "type": "object", "properties": { "list": {} } }, "response.PageResult": { "type": "object", "properties": { "list": {}, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } } }, "response.Response": { "type": "object", "properties": { "code": { "type": "integer" }, "data": {}, "msg": { "type": "string" } } }, "response.SysCaptchaResponse": { "type": "object", "properties": { "captchaId": { "type": "string" }, "captchaLength": { "type": "integer" }, "picPath": { "type": "string" } } }, "response.SysMenuResponse": { "type": "object", "properties": { "menu": { "$ref": "#/definitions/system.SysBaseMenu" } } }, "response.SysRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/definitions/system.SysRole" } } }, "response.SysUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/definitions/system.SysUser" } } }, "system.AutoCodeStruct": { "type": "object", "properties": { "abbreviation": { "description": "Struct简称", "type": "string" }, "autoCreateApiToSql": { "description": "是否自动创建api", "type": "boolean" }, "autoCreateMenuToSql": { "description": "是否自动创建menu", "type": "boolean" }, "autoCreateResource": { "description": "是否自动创建资源标识", "type": "boolean" }, "autoMoveFile": { "description": "是否自动移动文件", "type": "boolean" }, "businessDB": { "description": "业务数据库", "type": "string" }, "defaultModel": { "description": "是否使用默认Model", "type": "boolean" }, "description": { "description": "Struct中文名称", "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/system.Field" } }, "humpPackageName": { "description": "go文件名称", "type": "string" }, "package": { "type": "string" }, "packageName": { "description": "文件名称", "type": "string" }, "primaryField": { "$ref": "#/definitions/system.Field" }, "structName": { "description": "Struct名称", "type": "string" }, "tableName": { "description": "表名", "type": "string" } } }, "system.Field": { "type": "object", "properties": { "clearable": { "description": "是否可清空", "type": "boolean" }, "columnName": { "description": "数据库字段", "type": "string" }, "comment": { "description": "数据库字段描述", "type": "string" }, "dataTypeLong": { "description": "数据库字段长度", "type": "string" }, "dictType": { "description": "字典", "type": "string" }, "errorText": { "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" }, "primaryKey": { "description": "是否主键", "type": "boolean" }, "require": { "description": "是否必填", "type": "boolean" }, "sort": { "description": "是否增加排序", "type": "boolean" } } }, "system.Meta": { "type": "object", "properties": { "affix": { "type": "boolean" }, "icon": { "type": "string" }, "keepAlive": { "type": "boolean" }, "title": { "type": "string" } } }, "system.SysAutoCode": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "type": "string" }, "id": { "description": "主键 ID", "type": "integer" }, "label": { "type": "string" }, "packageName": { "type": "string" }, "updatedAt": { "type": "string" } } }, "system.SysBaseMenu": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/system.SysBaseMenu" } }, "component": { "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "hidden": { "type": "boolean" }, "id": { "description": "主键 ID", "type": "integer" }, "meta": { "$ref": "#/definitions/system.Meta" }, "name": { "type": "string" }, "parentId": { "type": "integer" }, "path": { "type": "string" }, "sort": { "type": "integer" }, "sysRoles": { "type": "array", "items": { "$ref": "#/definitions/system.SysRole" } }, "updatedAt": { "type": "string" } } }, "system.SysDept": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/system.SysDept" } }, "createdAt": { "type": "string" }, "deletedAt": { "type": "string" }, "deptId": { "type": "integer" }, "deptName": { "type": "string" }, "deptPath": { "type": "string" }, "email": { "type": "string" }, "leader": { "type": "string" }, "parentId": { "type": "integer" }, "phone": { "type": "string" }, "sort": { "type": "integer" }, "status": { "type": "string" }, "updatedAt": { "type": "string" } } }, "system.SysDictionary": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "type": "string" }, "id": { "description": "主键 ID", "type": "integer" }, "name": { "type": "string" }, "status": { "type": "boolean" }, "sys-dictionary-details": { "type": "array", "items": { "$ref": "#/definitions/system.SysDictionaryDetail" } }, "type": { "type": "string" }, "updatedAt": { "type": "string" } } }, "system.SysDictionaryDetail": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "extend": { "type": "string" }, "id": { "description": "主键 ID", "type": "integer" }, "label": { "type": "string" }, "sort": { "type": "integer" }, "status": { "type": "boolean" }, "sysDictionaryID": { "type": "integer" }, "updatedAt": { "type": "string" }, "value": { "type": "string" } } }, "system.SysRole": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/system.SysRole" } }, "createdAt": { "description": "创建时间", "type": "string" }, "dataRoleId": { "type": "array", "items": { "$ref": "#/definitions/system.SysRole" } }, "defaultRouter": { "description": "默认菜单(默认dashboard)", "type": "string" }, "deletedAt": { "description": "删除时间", "type": "string" }, "menus": { "type": "array", "items": { "$ref": "#/definitions/system.SysBaseMenu" } }, "parentId": { "description": "父角色ID", "type": "integer" }, "roleId": { "description": "角色ID", "type": "integer" }, "roleName": { "description": "角色名", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" } } }, "system.SysUser": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "deptsId": { "type": "integer" }, "email": { "description": "用户邮箱", "type": "string" }, "headerImg": { "description": "用户头像", "type": "string" }, "id": { "description": "主键 ID", "type": "integer" }, "nickName": { "description": "用户昵称", "type": "string" }, "phone": { "description": "用户手机号", "type": "string" }, "rolesId": { "description": "用户角色ID", "type": "integer" }, "sex": { "description": "用户性别 1为男，2为女", "type": "integer" }, "status": { "description": "用户状态 1为开启，2为禁用", "type": "integer" }, "sysDept": { "$ref": "#/definitions/system.SysDept" }, "sysRole": { "$ref": "#/definitions/system.SysRole" }, "sysRoles": { "type": "array", "items": { "$ref": "#/definitions/system.SysRole" } }, "themeColor": { "description": "用户主题颜色", "type": "string" }, "updatedAt": { "type": "string" }, "userName": { "description": "用户登录名", "type": "string" }, "uuid": { "type": "string" } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "name": "x-token", "in": "header" } } }