loser/Go-Web-Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5c2a146a447b371a502a42440f6ffb11520318ab
Go-Web-Template/server/docs/swagger.json

7976 lines
271 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"swagger": "2.0",
"info": {
"description": "使用gin+react进行极速开发的全栈开发基础平台",
"title": "Gin-React-Admin Swagger API接口文档",
"contact": {},
"version": "v2.9.1"
},
"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": "创建基础api",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除api",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除选中Api",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/enterSyncApi": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "确认同步API",
"responses": {
"200": {
"description": "确认同步API",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/freshCasbin": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "刷新casbin缓存",
"responses": {
"200": {
"description": "刷新成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/getAllApis": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "获取所有的Api 不分页",
"responses": {
"200": {
"description": "获取所有的Api 不分页,返回包括api列表",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysAPIListResponse"
},
"msg": {
"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": "根据id获取api,返回包括api详情",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysAPIResponse"
}
}
}
]
}
}
}
}
},
"/api/getApiGroups": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "获取API分组",
"responses": {
"200": {
"description": "获取API分组",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "分页获取API列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/getApiRoles": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "获取拥有指定API权限的角色ID列表",
"parameters": [
{
"type": "string",
"description": "API路径",
"name": "path",
"in": "query",
"required": true
},
{
"type": "string",
"description": "请求方法",
"name": "method",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/ignoreApi": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"IgnoreApi"
],
"summary": "忽略API",
"responses": {
"200": {
"description": "同步API",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/setApiRoles": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "全量覆盖某API关联的角色列表",
"parameters": [
{
"description": "API路径、请求方法和角色ID列表",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.SetApiAuthorities"
}
}
],
"responses": {
"200": {
"description": "设置成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/syncApi": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "同步API",
"responses": {
"200": {
"description": "同步API",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "修改基础api",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/attachmentCategory/addCategory": {
"post": {
"security": [
{
"AttachmentCategory": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AddCategory"
],
"summary": "添加媒体库分类",
"parameters": [
{
"description": "媒体库分类数据",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/common.ExaAttachmentCategory"
}
}
],
"responses": {}
}
},
"/attachmentCategory/deleteCategory": {
"post": {
"security": [
{
"AttachmentCategory": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"DeleteCategory"
],
"summary": "删除分类",
"parameters": [
{
"description": "分类id",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.GetById"
}
}
],
"responses": {
"200": {
"description": "删除分类",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/attachmentCategory/getCategoryList": {
"get": {
"security": [
{
"AttachmentCategory": []
}
],
"produces": [
"application/json"
],
"tags": [
"GetCategoryList"
],
"summary": "媒体库分类列表",
"responses": {
"200": {
"description": "媒体库分类列表",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/common.ExaAttachmentCategory"
},
"msg": {
"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": "拷贝角色,返回包括系统角色详情",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysAuthorityResponse"
},
"msg": {
"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": "创建角色,返回包括系统角色详情",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysAuthorityResponse"
},
"msg": {
"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": "删除角色",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "分页获取角色列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/authority/getUsersByAuthority": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Authority"
],
"summary": "获取拥有指定角色的用户ID列表",
"parameters": [
{
"type": "integer",
"description": "角色ID",
"name": "authorityId",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer"
}
},
"msg": {
"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": "设置角色资源权限",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/authority/setRoleUsers": {
"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/request.SetRoleUsers"
}
}
],
"responses": {
"200": {
"description": "设置成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/authority/updateAuthority": {
"put": {
"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": "更新角色信息,返回包括系统角色详情",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysAuthorityResponse"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/authorityBtn/canRemoveAuthorityBtn": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AuthorityBtn"
],
"summary": "设置权限按钮",
"responses": {
"200": {
"description": "删除成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/authorityBtn/getAuthorityBtn": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AuthorityBtn"
],
"summary": "获取权限按钮",
"parameters": [
{
"description": "菜单id, 角色id, 选中的按钮id",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.SysAuthorityBtnReq"
}
}
],
"responses": {
"200": {
"description": "返回列表成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysAuthorityBtnRes"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/authorityBtn/setAuthorityBtn": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AuthorityBtn"
],
"summary": "设置权限按钮",
"parameters": [
{
"description": "菜单id, 角色id, 选中的按钮id",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.SysAuthorityBtnReq"
}
}
],
"responses": {
"200": {
"description": "返回列表成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/base/captcha": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "生成验证码",
"responses": {
"200": {
"description": "生成验证码,返回包括随机数id,base64,验证码长度,是否开启验证码",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysCaptchaResponse"
},
"msg": {
"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": "返回包括用户信息,token,过期时间",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.LoginResponse"
},
"msg": {
"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": "更新角色api权限",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "获取权限列表,返回包括casbin详情列表",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PolicyPathResponse"
},
"msg": {
"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": "断点续传到服务器",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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/common.ExaFileUploadAndDownload"
}
}
],
"responses": {
"200": {
"description": "删除文件",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/fileUploadAndDownload/findFile": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"ExaFileUploadAndDownload"
],
"summary": "查找文件",
"parameters": [
{
"type": "file",
"description": "Find the file, 查找文件",
"name": "file",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "查找文件,返回包括文件详情",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.FileResponse"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
},
"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": "创建文件,返回包括文件路径",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.FilePathResponse"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/fileUploadAndDownload/getFileList": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"ExaFileUploadAndDownload"
],
"summary": "分页文件列表",
"parameters": [
{
"description": "页码, 每页大小, 分类id",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.ExaAttachmentCategorySearch"
}
}
],
"responses": {
"200": {
"description": "分页文件列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/fileUploadAndDownload/importURL": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"ExaFileUploadAndDownload"
],
"summary": "导入URL",
"parameters": [
{
"description": "对象",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/common.ExaFileUploadAndDownload"
}
}
],
"responses": {
"200": {
"description": "导入URL",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除切片",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "上传文件示例,返回包括文件详情",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.ExaFileResponse"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/init/checkdb": {
"post": {
"produces": [
"application/json"
],
"tags": [
"CheckDB"
],
"summary": "初始化用户数据库",
"responses": {
"200": {
"description": "初始化用户数据库",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"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": "初始化用户数据库",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/jwt/jsonInBlacklist": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Jwt"
],
"summary": "jwt加入黑名单",
"responses": {
"200": {
"description": "jwt加入黑名单",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "新增菜单",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "增加menu和角色关联关系",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除菜单",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "根据id获取菜单,返回包括系统菜单列表",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysBaseMenuResponse"
},
"msg": {
"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": "获取用户动态路由,返回包括系统菜单列表",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysBaseMenusResponse"
},
"msg": {
"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": "获取用户动态路由,返回包括系统菜单详情列表",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysMenusResponse"
},
"msg": {
"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": "获取指定角色menu",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"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": "分页获取基础menu列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/menu/getMenuRoles": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AuthorityMenu"
],
"summary": "获取拥有指定菜单的角色ID列表",
"parameters": [
{
"type": "integer",
"description": "菜单ID",
"name": "menuId",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/menu/setMenuRoles": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AuthorityMenu"
],
"summary": "全量覆盖某菜单关联的角色列表",
"parameters": [
{
"description": "菜单ID和角色ID列表",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.SetMenuAuthorities"
}
}
],
"responses": {
"200": {
"description": "设置成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "更新菜单",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "创建SysDictionary",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除SysDictionary",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionary/exportSysDictionary": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionary"
],
"summary": "导出字典JSON（包含字典详情）",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "描述",
"name": "desc",
"in": "query"
},
{
"type": "string",
"description": "字典名（中）",
"name": "name",
"in": "query"
},
{
"type": "integer",
"description": "父级字典ID",
"name": "parentID",
"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": "导出字典JSON",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionary/findSysDictionary": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionary"
],
"summary": "用id查询SysDictionary",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "描述",
"name": "desc",
"in": "query"
},
{
"type": "string",
"description": "字典名（中）",
"name": "name",
"in": "query"
},
{
"type": "integer",
"description": "父级字典ID",
"name": "parentID",
"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": "用id查询SysDictionary",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionary/getSysDictionaryList": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionary"
],
"summary": "分页获取SysDictionary列表",
"parameters": [
{
"type": "string",
"description": "字典名（中）",
"name": "name",
"in": "query"
}
],
"responses": {
"200": {
"description": "分页获取SysDictionary列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionary/importSysDictionary": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionary"
],
"summary": "导入字典JSON（包含字典详情）",
"parameters": [
{
"description": "字典JSON数据",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.ImportSysDictionaryRequest"
}
}
],
"responses": {
"200": {
"description": "导入字典",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "更新SysDictionary",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "创建SysDictionaryDetail",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除SysDictionaryDetail",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionaryDetail/findSysDictionaryDetail": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionaryDetail"
],
"summary": "用id查询SysDictionaryDetail",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "boolean",
"description": "禁用状态，根据status字段动态计算",
"name": "disabled",
"in": "query"
},
{
"type": "string",
"description": "扩展值",
"name": "extend",
"in": "query"
},
{
"type": "string",
"description": "展示值",
"name": "label",
"in": "query"
},
{
"type": "integer",
"description": "层级深度，从0开始",
"name": "level",
"in": "query"
},
{
"type": "integer",
"description": "父级字典详情ID",
"name": "parentID",
"in": "query"
},
{
"type": "string",
"description": "层级路径，如 \"1,2,3\"",
"name": "path",
"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": "string",
"description": "字典值",
"name": "value",
"in": "query"
}
],
"responses": {
"200": {
"description": "用id查询SysDictionaryDetail",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionaryDetail/getDictionaryDetailsByParent": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionaryDetail"
],
"summary": "根据父级ID获取字典详情",
"parameters": [
{
"type": "boolean",
"description": "是否包含子级数据",
"name": "includeChildren",
"in": "query"
},
{
"type": "integer",
"description": "父级字典详情ID，为空时获取顶级",
"name": "parentID",
"in": "query"
},
{
"type": "integer",
"description": "字典ID",
"name": "sysDictionaryID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取字典详情列表",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysDictionaryDetail"
}
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionaryDetail/getDictionaryPath": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionaryDetail"
],
"summary": "获取字典详情的完整路径",
"parameters": [
{
"type": "integer",
"description": "字典详情ID",
"name": "id",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取字典详情路径",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysDictionaryDetail"
}
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionaryDetail/getDictionaryTreeList": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionaryDetail"
],
"summary": "获取字典详情树形结构",
"parameters": [
{
"type": "integer",
"description": "字典ID",
"name": "sysDictionaryID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取字典详情树形结构",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysDictionaryDetail"
}
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionaryDetail/getDictionaryTreeListByType": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionaryDetail"
],
"summary": "根据字典类型获取字典详情树形结构",
"parameters": [
{
"type": "string",
"description": "字典类型",
"name": "type",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取字典详情树形结构",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysDictionaryDetail"
}
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysDictionaryDetail/getSysDictionaryDetailList": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysDictionaryDetail"
],
"summary": "分页获取SysDictionaryDetail列表",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "boolean",
"description": "禁用状态，根据status字段动态计算",
"name": "disabled",
"in": "query"
},
{
"type": "string",
"description": "扩展值",
"name": "extend",
"in": "query"
},
{
"type": "string",
"description": "关键字",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "展示值",
"name": "label",
"in": "query"
},
{
"type": "integer",
"description": "层级深度，用于查询指定层级的数据",
"name": "level",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页大小",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "父级字典详情ID，用于查询指定父级下的子项",
"name": "parentID",
"in": "query"
},
{
"type": "string",
"description": "层级路径，如 \"1,2,3\"",
"name": "path",
"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": "string",
"description": "字典值",
"name": "value",
"in": "query"
}
],
"responses": {
"200": {
"description": "分页获取SysDictionaryDetail列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"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": "更新SysDictionaryDetail",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysError/createSysError": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysError"
],
"summary": "创建错误日志",
"parameters": [
{
"description": "创建错误日志",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysError"
}
}
],
"responses": {
"200": {
"description": "创建成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysError/deleteSysError": {
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysError"
],
"summary": "删除错误日志",
"parameters": [
{
"description": "删除错误日志",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysError"
}
}
],
"responses": {
"200": {
"description": "删除成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysError/deleteSysErrorByIds": {
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysError"
],
"summary": "批量删除错误日志",
"responses": {
"200": {
"description": "批量删除成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysError/findSysError": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysError"
],
"summary": "用id查询错误日志",
"parameters": [
{
"type": "integer",
"description": "用id查询错误日志",
"name": "ID",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "查询成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/system.SysError"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysError/getSysErrorList": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysError"
],
"summary": "分页获取错误日志列表",
"parameters": [
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "createdAtRange",
"in": "query"
},
{
"type": "string",
"name": "form",
"in": "query"
},
{
"type": "string",
"name": "info",
"in": "query"
},
{
"type": "string",
"description": "关键字",
"name": "keyword",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页大小",
"name": "pageSize",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysError/getSysErrorSolution": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysError"
],
"summary": "根据ID触发处理：标记为处理中，1分钟后自动改为处理完成",
"parameters": [
{
"type": "string",
"description": "错误日志ID",
"name": "id",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "处理已提交",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysError/updateSysError": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysError"
],
"summary": "更新错误日志",
"parameters": [
{
"description": "更新错误日志",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysError"
}
}
],
"responses": {
"200": {
"description": "更新成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除SysOperationRecord",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "批量删除SysOperationRecord",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysOperationRecord/findSysOperationRecord": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysOperationRecord"
],
"summary": "用id查询SysOperationRecord",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"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": "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": "用id查询SysOperationRecord",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysOperationRecord/getSysOperationRecordList": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysOperationRecord"
],
"summary": "分页获取SysOperationRecord列表",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"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": "string",
"description": "请求ip",
"name": "ip",
"in": "query"
},
{
"type": "string",
"description": "关键字",
"name": "keyword",
"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": "分页获取SysOperationRecord列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysParams/createSysParams": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysParams"
],
"summary": "创建参数",
"parameters": [
{
"description": "创建参数",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysParams"
}
}
],
"responses": {
"200": {
"description": "创建成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysParams/deleteSysParams": {
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysParams"
],
"summary": "删除参数",
"parameters": [
{
"description": "删除参数",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysParams"
}
}
],
"responses": {
"200": {
"description": "删除成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysParams/deleteSysParamsByIds": {
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysParams"
],
"summary": "批量删除参数",
"responses": {
"200": {
"description": "批量删除成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysParams/findSysParams": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysParams"
],
"summary": "用id查询参数",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "参数说明",
"name": "desc",
"in": "query"
},
{
"type": "string",
"description": "参数键",
"name": "key",
"in": "query",
"required": true
},
{
"type": "string",
"description": "参数名称",
"name": "name",
"in": "query",
"required": true
},
{
"type": "string",
"description": "更新时间",
"name": "updatedAt",
"in": "query"
},
{
"type": "string",
"description": "参数值",
"name": "value",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "查询成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/system.SysParams"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysParams/getSysParam": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysParams"
],
"summary": "根据key获取参数value",
"parameters": [
{
"type": "string",
"description": "key",
"name": "key",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/system.SysParams"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysParams/getSysParamsList": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysParams"
],
"summary": "分页获取参数列表",
"parameters": [
{
"type": "string",
"name": "endCreatedAt",
"in": "query"
},
{
"type": "string",
"name": "key",
"in": "query"
},
{
"type": "string",
"description": "关键字",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"name": "name",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页大小",
"name": "pageSize",
"in": "query"
},
{
"type": "string",
"name": "startCreatedAt",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/sysParams/updateSysParams": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysParams"
],
"summary": "更新参数",
"parameters": [
{
"description": "更新参数",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysParams"
}
}
],
"responses": {
"200": {
"description": "更新成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/system/getServerInfo": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"System"
],
"summary": "获取服务器信息",
"responses": {
"200": {
"description": "获取服务器信息",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/system/getSystemConfig": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"System"
],
"summary": "获取配置文件内容",
"responses": {
"200": {
"description": "获取配置文件内容,返回包括系统配置",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysConfigResponse"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/system/reloadSystem": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"System"
],
"summary": "重载系统",
"responses": {
"200": {
"description": "重载系统",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "设置配置文件内容",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/user/SetSelfInfo": {
"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": "设置用户信息",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/user/SetSelfSetting": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "设置用户配置",
"parameters": [
{
"description": "用户配置数据",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"additionalProperties": true
}
}
],
"responses": {
"200": {
"description": "设置用户配置",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/user/admin_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": "用户注册账号,返回包括用户信息",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.SysUserResponse"
},
"msg": {
"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.ChangePasswordReq"
}
}
],
"responses": {
"200": {
"description": "用户修改密码",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "删除用户",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/user/getUserInfo": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "获取用户信息",
"responses": {
"200": {
"description": "获取用户信息",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"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.GetUserList"
}
}
],
"responses": {
"200": {
"description": "分页获取用户列表,返回包括列表,总数,页码,每页数量",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/response.PageResult"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/user/resetPassword": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "重置用户密码",
"parameters": [
{
"description": "ID",
"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/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": "设置用户权限",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "设置用户权限",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"msg": {
"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": "设置用户信息",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
}
},
"definitions": {
"common.ExaAttachmentCategory": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ExaAttachmentCategory"
}
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"name": {
"type": "string"
},
"pid": {
"type": "integer"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"common.ExaFile": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"chunkTotal": {
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"exaFileChunk": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ExaFileChunk"
}
},
"fileMd5": {
"type": "string"
},
"fileName": {
"type": "string"
},
"filePath": {
"type": "string"
},
"isFinish": {
"type": "boolean"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"common.ExaFileChunk": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"exaFileID": {
"type": "integer"
},
"fileChunkNumber": {
"type": "integer"
},
"fileChunkPath": {
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"common.ExaFileUploadAndDownload": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"classId": {
"description": "分类id",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"key": {
"description": "编号",
"type": "string"
},
"name": {
"description": "文件名",
"type": "string"
},
"tag": {
"description": "文件标签",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
},
"url": {
"description": "文件地址",
"type": "string"
}
}
},
"common.JSONMap": {
"type": "object",
"additionalProperties": true
},
"config.AliyunOSS": {
"type": "object",
"properties": {
"access-key-id": {
"type": "string"
},
"access-key-secret": {
"type": "string"
},
"base-path": {
"type": "string"
},
"bucket-name": {
"type": "string"
},
"bucket-url": {
"type": "string"
},
"endpoint": {
"type": "string"
}
}
},
"config.AwsS3": {
"type": "object",
"properties": {
"base-url": {
"type": "string"
},
"bucket": {
"type": "string"
},
"disable-ssl": {
"type": "boolean"
},
"endpoint": {
"type": "string"
},
"path-prefix": {
"type": "string"
},
"region": {
"type": "string"
},
"s3-force-path-style": {
"type": "boolean"
},
"secret-id": {
"type": "string"
},
"secret-key": {
"type": "string"
}
}
},
"config.CORS": {
"type": "object",
"properties": {
"mode": {
"type": "string"
},
"whitelist": {
"type": "array",
"items": {
"$ref": "#/definitions/config.CORSWhitelist"
}
}
}
},
"config.CORSWhitelist": {
"type": "object",
"properties": {
"allow-credentials": {
"type": "boolean"
},
"allow-headers": {
"type": "string"
},
"allow-methods": {
"type": "string"
},
"allow-origin": {
"type": "string"
},
"expose-headers": {
"type": "string"
}
}
},
"config.Captcha": {
"type": "object",
"properties": {
"img-height": {
"description": "验证码高度",
"type": "integer"
},
"img-width": {
"description": "验证码宽度",
"type": "integer"
},
"key-long": {
"description": "验证码长度",
"type": "integer"
},
"open-captcha": {
"description": "防爆破验证码开启此数，0代表每次登录都需要验证码，其他数字代表错误密码次数，如3代表错误三次后出现验证码",
"type": "integer"
},
"open-captcha-timeout": {
"description": "防爆破验证码超时时间，单位：s(秒)",
"type": "integer"
}
}
},
"config.CloudflareR2": {
"type": "object",
"properties": {
"access-key-id": {
"type": "string"
},
"account-id": {
"type": "string"
},
"base-url": {
"type": "string"
},
"bucket": {
"type": "string"
},
"path": {
"type": "string"
},
"secret-access-key": {
"type": "string"
}
}
},
"config.DiskList": {
"type": "object",
"properties": {
"mount-point": {
"type": "string"
}
}
},
"config.Email": {
"type": "object",
"properties": {
"from": {
"description": "发件人 你自己要发邮件的邮箱",
"type": "string"
},
"host": {
"description": "服务器地址 例如 smtp.qq.com 请前往QQ或者你要发邮件的邮箱查看其smtp协议",
"type": "string"
},
"is-loginauth": {
"description": "是否LoginAuth 是否使用LoginAuth认证方式（适用于IBM、微软邮箱服务器等）",
"type": "boolean"
},
"is-ssl": {
"description": "是否SSL 是否开启SSL",
"type": "boolean"
},
"nickname": {
"description": "昵称 发件人昵称 通常为自己的邮箱",
"type": "string"
},
"port": {
"description": "端口 请前往QQ或者你要发邮件的邮箱查看其smtp协议 大多为 465",
"type": "integer"
},
"secret": {
"description": "密钥 用于登录的密钥 最好不要用邮箱密码 去邮箱smtp申请一个用于登录的密钥",
"type": "string"
},
"to": {
"description": "收件人:多个以英文逗号分隔 例：a@qq.com b@qq.com 正式开发中请把此项目作为参数使用",
"type": "string"
}
}
},
"config.Excel": {
"type": "object",
"properties": {
"dir": {
"type": "string"
}
}
},
"config.HuaWeiObs": {
"type": "object",
"properties": {
"access-key": {
"type": "string"
},
"bucket": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"path": {
"type": "string"
},
"secret-key": {
"type": "string"
}
}
},
"config.JWT": {
"type": "object",
"properties": {
"buffer-time": {
"description": "缓冲时间",
"type": "string"
},
"expires-time": {
"description": "过期时间",
"type": "string"
},
"issuer": {
"description": "签发者",
"type": "string"
},
"signing-key": {
"description": "jwt签名",
"type": "string"
}
}
},
"config.Local": {
"type": "object",
"properties": {
"path": {
"description": "本地文件访问路径",
"type": "string"
},
"store-path": {
"description": "本地文件存储路径",
"type": "string"
}
}
},
"config.MCP": {
"type": "object",
"properties": {
"addr": {
"type": "integer"
},
"auth_header": {
"type": "string"
},
"base_url": {
"type": "string"
},
"message_path": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"request_timeout": {
"type": "integer"
},
"separate": {
"type": "boolean"
},
"sse_path": {
"description": "Deprecated fields kept for backward compatibility with older configs.",
"type": "string"
},
"upstream_base_url": {
"type": "string"
},
"url_prefix": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"config.Minio": {
"type": "object",
"properties": {
"access-key-id": {
"type": "string"
},
"access-key-secret": {
"type": "string"
},
"base-path": {
"type": "string"
},
"bucket-name": {
"type": "string"
},
"bucket-url": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"use-ssl": {
"type": "boolean"
}
}
},
"config.Mongo": {
"type": "object",
"properties": {
"auth-source": {
"description": "验证数据库",
"type": "string"
},
"coll": {
"description": "collection name",
"type": "string"
},
"connect-timeout-ms": {
"description": "连接超时时间",
"type": "integer"
},
"database": {
"description": "database name",
"type": "string"
},
"hosts": {
"description": "主机列表",
"type": "array",
"items": {
"$ref": "#/definitions/config.MongoHost"
}
},
"is-zap": {
"description": "是否开启zap日志",
"type": "boolean"
},
"max-pool-size": {
"description": "最大连接池",
"type": "integer"
},
"min-pool-size": {
"description": "最小连接池",
"type": "integer"
},
"options": {
"description": "mongodb options",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"socket-timeout-ms": {
"description": "socket超时时间",
"type": "integer"
},
"username": {
"description": "用户名",
"type": "string"
}
}
},
"config.MongoHost": {
"type": "object",
"properties": {
"host": {
"description": "ip地址",
"type": "string"
},
"port": {
"description": "端口",
"type": "string"
}
}
},
"config.Mssql": {
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"engine": {
"description": "数据库引擎，默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数，true表示开启",
"type": "boolean"
},
"username": {
"description": "数据库账号",
"type": "string"
}
}
},
"config.Mysql": {
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"engine": {
"description": "数据库引擎，默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数，true表示开启",
"type": "boolean"
},
"username": {
"description": "数据库账号",
"type": "string"
}
}
},
"config.Oracle": {
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"engine": {
"description": "数据库引擎，默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数，true表示开启",
"type": "boolean"
},
"username": {
"description": "数据库账号",
"type": "string"
}
}
},
"config.Pgsql": {
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"engine": {
"description": "数据库引擎，默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数，true表示开启",
"type": "boolean"
},
"username": {
"description": "数据库账号",
"type": "string"
}
}
},
"config.Qiniu": {
"type": "object",
"properties": {
"access-key": {
"description": "秘钥AK",
"type": "string"
},
"bucket": {
"description": "空间名称",
"type": "string"
},
"img-path": {
"description": "CDN加速域名",
"type": "string"
},
"secret-key": {
"description": "秘钥SK",
"type": "string"
},
"use-cdn-domains": {
"description": "上传是否使用CDN上传加速",
"type": "boolean"
},
"use-https": {
"description": "是否使用https",
"type": "boolean"
},
"zone": {
"description": "存储区域",
"type": "string"
}
}
},
"config.Redis": {
"type": "object",
"properties": {
"addr": {
"description": "服务器地址:端口",
"type": "string"
},
"clusterAddrs": {
"description": "集群模式下的节点地址列表",
"type": "array",
"items": {
"type": "string"
}
},
"db": {
"description": "单实例模式下redis的哪个数据库",
"type": "integer"
},
"name": {
"description": "代表当前实例的名字",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"useCluster": {
"description": "是否使用集群模式",
"type": "boolean"
}
}
},
"config.Server": {
"type": "object",
"properties": {
"aliyun-oss": {
"$ref": "#/definitions/config.AliyunOSS"
},
"aws-s3": {
"$ref": "#/definitions/config.AwsS3"
},
"captcha": {
"$ref": "#/definitions/config.Captcha"
},
"cloudflare-r2": {
"$ref": "#/definitions/config.CloudflareR2"
},
"cors": {
"description": "跨域配置",
"allOf": [
{
"$ref": "#/definitions/config.CORS"
}
]
},
"db-list": {
"type": "array",
"items": {
"$ref": "#/definitions/config.SpecializedDB"
}
},
"disk-list": {
"type": "array",
"items": {
"$ref": "#/definitions/config.DiskList"
}
},
"email": {
"$ref": "#/definitions/config.Email"
},
"excel": {
"$ref": "#/definitions/config.Excel"
},
"hua-wei-obs": {
"$ref": "#/definitions/config.HuaWeiObs"
},
"jwt": {
"$ref": "#/definitions/config.JWT"
},
"local": {
"description": "oss",
"allOf": [
{
"$ref": "#/definitions/config.Local"
}
]
},
"mcp": {
"description": "MCP配置",
"allOf": [
{
"$ref": "#/definitions/config.MCP"
}
]
},
"minio": {
"$ref": "#/definitions/config.Minio"
},
"mongo": {
"$ref": "#/definitions/config.Mongo"
},
"mssql": {
"$ref": "#/definitions/config.Mssql"
},
"mysql": {
"description": "gorm",
"allOf": [
{
"$ref": "#/definitions/config.Mysql"
}
]
},
"oracle": {
"$ref": "#/definitions/config.Oracle"
},
"pgsql": {
"$ref": "#/definitions/config.Pgsql"
},
"qiniu": {
"$ref": "#/definitions/config.Qiniu"
},
"redis": {
"$ref": "#/definitions/config.Redis"
},
"redis-list": {
"type": "array",
"items": {
"$ref": "#/definitions/config.Redis"
}
},
"sqlite": {
"$ref": "#/definitions/config.Sqlite"
},
"system": {
"$ref": "#/definitions/config.System"
},
"tencent-cos": {
"$ref": "#/definitions/config.TencentCOS"
},
"zap": {
"$ref": "#/definitions/config.Zap"
}
}
},
"config.SpecializedDB": {
"type": "object",
"properties": {
"alias-name": {
"type": "string"
},
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"disable": {
"type": "boolean"
},
"engine": {
"description": "数据库引擎，默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数，true表示开启",
"type": "boolean"
},
"type": {
"type": "string"
},
"username": {
"description": "数据库账号",
"type": "string"
}
}
},
"config.Sqlite": {
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"engine": {
"description": "数据库引擎，默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数，true表示开启",
"type": "boolean"
},
"username": {
"description": "数据库账号",
"type": "string"
}
}
},
"config.System": {
"type": "object",
"properties": {
"addr": {
"description": "端口值",
"type": "integer"
},
"db-type": {
"description": "数据库类型:mysql(默认)|sqlite|sqlserver|postgresql",
"type": "string"
},
"disable-auto-migrate": {
"description": "自动迁移数据库表结构，生产环境建议设为false，手动迁移",
"type": "boolean"
},
"iplimit-count": {
"type": "integer"
},
"iplimit-time": {
"type": "integer"
},
"oss-type": {
"description": "Oss类型",
"type": "string"
},
"router-prefix": {
"type": "string"
},
"use-mongo": {
"description": "使用mongo",
"type": "boolean"
},
"use-multipoint": {
"description": "多点登录拦截",
"type": "boolean"
},
"use-redis": {
"description": "使用redis",
"type": "boolean"
},
"use-strict-auth": {
"description": "使用树形角色分配模式",
"type": "boolean"
}
}
},
"config.TencentCOS": {
"type": "object",
"properties": {
"base-url": {
"type": "string"
},
"bucket": {
"type": "string"
},
"path-prefix": {
"type": "string"
},
"region": {
"type": "string"
},
"secret-id": {
"type": "string"
},
"secret-key": {
"type": "string"
}
}
},
"config.Zap": {
"type": "object",
"properties": {
"director": {
"description": "日志文件夹",
"type": "string"
},
"encode-level": {
"description": "编码级",
"type": "string"
},
"format": {
"description": "输出",
"type": "string"
},
"level": {
"description": "级别",
"type": "string"
},
"log-in-console": {
"description": "输出控制台",
"type": "boolean"
},
"prefix": {
"description": "日志前缀",
"type": "string"
},
"retention-day": {
"description": "日志保留天数",
"type": "integer"
},
"show-line": {
"description": "显示行",
"type": "boolean"
},
"stacktrace-key": {
"description": "栈名",
"type": "string"
}
}
},
"request.AddMenuAuthorityInfo": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "integer"
},
"menus": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysBaseMenu"
}
}
}
},
"request.CasbinInReceive": {
"type": "object",
"properties": {
"authorityId": {
"description": "权限id",
"type": "integer"
},
"casbinInfos": {
"type": "array",
"items": {
"$ref": "#/definitions/request.CasbinInfo"
}
}
}
},
"request.CasbinInfo": {
"type": "object",
"properties": {
"method": {
"description": "方法",
"type": "string"
},
"path": {
"description": "路径",
"type": "string"
}
}
},
"request.ChangePasswordReq": {
"type": "object",
"properties": {
"newPassword": {
"description": "新密码",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
}
}
},
"request.Empty": {
"type": "object"
},
"request.ExaAttachmentCategorySearch": {
"type": "object",
"properties": {
"classId": {
"type": "integer"
},
"keyword": {
"description": "关键字",
"type": "string"
},
"page": {
"description": "页码",
"type": "integer"
},
"pageSize": {
"description": "每页大小",
"type": "integer"
}
}
},
"request.GetAuthorityId": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "integer"
}
}
},
"request.GetById": {
"type": "object",
"properties": {
"id": {
"description": "主键ID",
"type": "integer"
}
}
},
"request.GetUserList": {
"type": "object",
"properties": {
"desc": {
"description": "排序方式:升序false(默认)|降序true",
"type": "boolean"
},
"email": {
"type": "string"
},
"keyword": {
"description": "关键字",
"type": "string"
},
"nickName": {
"type": "string"
},
"orderKey": {
"description": "排序",
"type": "string"
},
"page": {
"description": "页码",
"type": "integer"
},
"pageSize": {
"description": "每页大小",
"type": "integer"
},
"phone": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"request.IdsReq": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"request.ImportSysDictionaryRequest": {
"type": "object",
"required": [
"json"
],
"properties": {
"json": {
"description": "JSON字符串",
"type": "string"
}
}
},
"request.InitDB": {
"type": "object",
"required": [
"adminPassword",
"dbName"
],
"properties": {
"adminPassword": {
"type": "string"
},
"dbName": {
"description": "数据库名",
"type": "string"
},
"dbPath": {
"description": "sqlite数据库文件路径",
"type": "string"
},
"dbType": {
"description": "数据库类型",
"type": "string"
},
"host": {
"description": "服务器地址",
"type": "string"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"port": {
"description": "数据库连接端口",
"type": "string"
},
"template": {
"description": "postgresql指定template",
"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": {
"keyword": {
"description": "关键字",
"type": "string"
},
"page": {
"description": "页码",
"type": "integer"
},
"pageSize": {
"description": "每页大小",
"type": "integer"
}
}
},
"request.Register": {
"type": "object",
"properties": {
"authorityId": {
"type": "string",
"example": "int 角色id"
},
"authorityIds": {
"type": "string",
"example": "[]uint 角色id"
},
"email": {
"type": "string",
"example": "电子邮箱"
},
"enable": {
"type": "string",
"example": "int 是否启用"
},
"headerImg": {
"type": "string",
"example": "头像链接"
},
"nickName": {
"type": "string",
"example": "昵称"
},
"passWord": {
"type": "string",
"example": "密码"
},
"phone": {
"type": "string",
"example": "电话号码"
},
"userName": {
"type": "string",
"example": "用户名"
}
}
},
"request.SearchApiParams": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"apiGroup": {
"description": "api组",
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"desc": {
"description": "排序方式:升序false(默认)|降序true",
"type": "boolean"
},
"description": {
"description": "api中文描述",
"type": "string"
},
"keyword": {
"description": "关键字",
"type": "string"
},
"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.SetApiAuthorities": {
"type": "object",
"properties": {
"authorityIds": {
"description": "角色ID列表",
"type": "array",
"items": {
"type": "integer"
}
},
"method": {
"description": "请求方法",
"type": "string"
},
"path": {
"description": "API路径",
"type": "string"
}
}
},
"request.SetMenuAuthorities": {
"type": "object",
"properties": {
"authorityIds": {
"description": "角色ID列表",
"type": "array",
"items": {
"type": "integer"
}
},
"menuId": {
"description": "菜单ID",
"type": "integer"
}
}
},
"request.SetRoleUsers": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "integer"
},
"userIds": {
"description": "用户ID列表",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"request.SetUserAuth": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "integer"
}
}
},
"request.SetUserAuthorities": {
"type": "object",
"properties": {
"authorityIds": {
"description": "角色ID",
"type": "array",
"items": {
"type": "integer"
}
},
"id": {
"type": "integer"
}
}
},
"request.SysAuthorityBtnReq": {
"type": "object",
"properties": {
"authorityId": {
"type": "integer"
},
"menuID": {
"type": "integer"
},
"selected": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"response.ExaFileResponse": {
"type": "object",
"properties": {
"file": {
"$ref": "#/definitions/common.ExaFileUploadAndDownload"
}
}
},
"response.FilePathResponse": {
"type": "object",
"properties": {
"filePath": {
"type": "string"
}
}
},
"response.FileResponse": {
"type": "object",
"properties": {
"file": {
"$ref": "#/definitions/common.ExaFile"
}
}
},
"response.LoginResponse": {
"type": "object",
"properties": {
"expiresAt": {
"type": "integer"
},
"token": {
"type": "string"
},
"user": {
"$ref": "#/definitions/system.SysUser"
}
}
},
"response.PageResult": {
"type": "object",
"properties": {
"list": {},
"page": {
"type": "integer"
},
"pageSize": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"response.PolicyPathResponse": {
"type": "object",
"properties": {
"paths": {
"type": "array",
"items": {
"$ref": "#/definitions/request.CasbinInfo"
}
}
}
},
"response.Response": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {},
"msg": {
"type": "string"
}
}
},
"response.SysAPIListResponse": {
"type": "object",
"properties": {
"apis": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysApi"
}
}
}
},
"response.SysAPIResponse": {
"type": "object",
"properties": {
"api": {
"$ref": "#/definitions/system.SysApi"
}
}
},
"response.SysAuthorityBtnRes": {
"type": "object",
"properties": {
"selected": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"response.SysAuthorityCopyResponse": {
"type": "object",
"properties": {
"authority": {
"$ref": "#/definitions/system.SysAuthority"
},
"oldAuthorityId": {
"description": "旧角色ID",
"type": "integer"
}
}
},
"response.SysAuthorityResponse": {
"type": "object",
"properties": {
"authority": {
"$ref": "#/definitions/system.SysAuthority"
}
}
},
"response.SysBaseMenuResponse": {
"type": "object",
"properties": {
"menu": {
"$ref": "#/definitions/system.SysBaseMenu"
}
}
},
"response.SysBaseMenusResponse": {
"type": "object",
"properties": {
"menus": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysBaseMenu"
}
}
}
},
"response.SysCaptchaResponse": {
"type": "object",
"properties": {
"captchaId": {
"type": "string"
},
"captchaLength": {
"type": "integer"
},
"openCaptcha": {
"type": "boolean"
},
"picPath": {
"type": "string"
}
}
},
"response.SysConfigResponse": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/config.Server"
}
}
},
"response.SysMenusResponse": {
"type": "object",
"properties": {
"menus": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysMenu"
}
}
}
},
"response.SysUserResponse": {
"type": "object",
"properties": {
"user": {
"$ref": "#/definitions/system.SysUser"
}
}
},
"system.Meta": {
"type": "object",
"properties": {
"activeName": {
"type": "string"
},
"closeTab": {
"description": "自动关闭tab",
"type": "boolean"
},
"defaultMenu": {
"description": "是否是基础路由（开发中）",
"type": "boolean"
},
"icon": {
"description": "菜单图标",
"type": "string"
},
"keepAlive": {
"description": "是否缓存",
"type": "boolean"
},
"title": {
"description": "菜单名",
"type": "string"
},
"transitionType": {
"description": "路由切换动画",
"type": "string"
}
}
},
"system.SysApi": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"apiGroup": {
"description": "api组",
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"description": {
"description": "api中文描述",
"type": "string"
},
"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": "integer"
},
"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": "integer"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"system.SysBaseMenu": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"authoritys": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysAuthority"
}
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysBaseMenu"
}
},
"component": {
"description": "对应前端文件路径",
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"hidden": {
"description": "是否在列表隐藏",
"type": "boolean"
},
"menuBtn": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysBaseMenuBtn"
}
},
"meta": {
"description": "附加属性",
"allOf": [
{
"$ref": "#/definitions/system.Meta"
}
]
},
"name": {
"description": "路由name",
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysBaseMenuParameter"
}
},
"parentId": {
"description": "父菜单ID",
"type": "integer"
},
"path": {
"description": "路由path",
"type": "string"
},
"sort": {
"description": "排序标记",
"type": "integer"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"system.SysBaseMenuBtn": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"desc": {
"type": "string"
},
"name": {
"type": "string"
},
"sysBaseMenuID": {
"type": "integer"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"system.SysBaseMenuParameter": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"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": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"children": {
"description": "子字典",
"type": "array",
"items": {
"$ref": "#/definitions/system.SysDictionary"
}
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"desc": {
"description": "描述",
"type": "string"
},
"name": {
"description": "字典名（中）",
"type": "string"
},
"parentID": {
"description": "父级字典ID",
"type": "integer"
},
"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": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"children": {
"description": "子字典详情",
"type": "array",
"items": {
"$ref": "#/definitions/system.SysDictionaryDetail"
}
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"disabled": {
"description": "禁用状态，根据status字段动态计算",
"type": "boolean"
},
"extend": {
"description": "扩展值",
"type": "string"
},
"label": {
"description": "展示值",
"type": "string"
},
"level": {
"description": "层级深度，从0开始",
"type": "integer"
},
"parentID": {
"description": "父级字典详情ID",
"type": "integer"
},
"path": {
"description": "层级路径，如 \"1,2,3\"",
"type": "string"
},
"sort": {
"description": "排序标记",
"type": "integer"
},
"status": {
"description": "启用状态",
"type": "boolean"
},
"sysDictionaryID": {
"description": "关联标记",
"type": "integer"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
},
"value": {
"description": "字典值",
"type": "string"
}
}
},
"system.SysError": {
"type": "object",
"required": [
"form"
],
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"form": {
"description": "错误来源",
"type": "string"
},
"info": {
"description": "错误内容",
"type": "string"
},
"level": {
"type": "string"
},
"solution": {
"description": "解决方案",
"type": "string"
},
"status": {
"description": "处理状态：未处理/处理中/处理完成",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"system.SysMenu": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"authoritys": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysAuthority"
}
},
"btns": {
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysMenu"
}
},
"component": {
"description": "对应前端文件路径",
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"hidden": {
"description": "是否在列表隐藏",
"type": "boolean"
},
"menuBtn": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysBaseMenuBtn"
}
},
"menuId": {
"type": "integer"
},
"meta": {
"description": "附加属性",
"allOf": [
{
"$ref": "#/definitions/system.Meta"
}
]
},
"name": {
"description": "路由name",
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/system.SysBaseMenuParameter"
}
},
"parentId": {
"description": "父菜单ID",
"type": "integer"
},
"path": {
"description": "路由path",
"type": "string"
},
"sort": {
"description": "排序标记",
"type": "integer"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"system.SysOperationRecord": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"agent": {
"description": "代理",
"type": "string"
},
"body": {
"description": "请求Body",
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"error_message": {
"description": "错误信息",
"type": "string"
},
"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.SysParams": {
"type": "object",
"required": [
"key",
"name",
"value"
],
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"desc": {
"description": "参数说明",
"type": "string"
},
"key": {
"description": "参数键",
"type": "string"
},
"name": {
"description": "参数名称",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
},
"value": {
"description": "参数值",
"type": "string"
}
}
},
"system.SysUser": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"authorities": {
"description": "多用户角色",
"type": "array",
"items": {
"$ref": "#/definitions/system.SysAuthority"
}
},
"authority": {
"description": "用户角色",
"allOf": [
{
"$ref": "#/definitions/system.SysAuthority"
}
]
},
"authorityId": {
"description": "用户角色ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"email": {
"description": "用户邮箱",
"type": "string"
},
"enable": {
"description": "用户是否被冻结 1正常 2冻结",
"type": "integer"
},
"headerImg": {
"description": "用户头像",
"type": "string"
},
"nickName": {
"description": "用户昵称",
"type": "string"
},
"originSetting": {
"description": "配置",
"allOf": [
{
"$ref": "#/definitions/common.JSONMap"
}
]
},
"phone": {
"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"
}
},
"tags": [
{
"name": "Base"
},
{
"description": "用户",
"name": "SysUser"
}
]
}
Reference in New Issue View Git Blame Copy Permalink