Files
Go-Web-Template/server/docs/swagger.yaml

4868 lines
117 KiB
YAML
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.

definitions:
common.ExaAttachmentCategory:
properties:
ID:
description: 主键ID
type: integer
children:
items:
$ref: '#/definitions/common.ExaAttachmentCategory'
type: array
createdAt:
description: 创建时间
type: string
name:
type: string
pid:
type: integer
updatedAt:
description: 更新时间
type: string
type: object
common.ExaFile:
properties:
ID:
description: 主键ID
type: integer
chunkTotal:
type: integer
createdAt:
description: 创建时间
type: string
exaFileChunk:
items:
$ref: '#/definitions/common.ExaFileChunk'
type: array
fileMd5:
type: string
fileName:
type: string
filePath:
type: string
isFinish:
type: boolean
updatedAt:
description: 更新时间
type: string
type: object
common.ExaFileChunk:
properties:
ID:
description: 主键ID
type: integer
createdAt:
description: 创建时间
type: string
exaFileID:
type: integer
fileChunkNumber:
type: integer
fileChunkPath:
type: string
updatedAt:
description: 更新时间
type: string
type: object
common.ExaFileUploadAndDownload:
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
type: object
common.JSONMap:
additionalProperties: true
type: object
config.AliyunOSS:
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
type: object
config.AwsS3:
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
type: object
config.CORS:
properties:
mode:
type: string
whitelist:
items:
$ref: '#/definitions/config.CORSWhitelist'
type: array
type: object
config.CORSWhitelist:
properties:
allow-credentials:
type: boolean
allow-headers:
type: string
allow-methods:
type: string
allow-origin:
type: string
expose-headers:
type: string
type: object
config.Captcha:
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
type: object
config.CloudflareR2:
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
type: object
config.DiskList:
properties:
mount-point:
type: string
type: object
config.Email:
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
type: object
config.Excel:
properties:
dir:
type: string
type: object
config.HuaWeiObs:
properties:
access-key:
type: string
bucket:
type: string
endpoint:
type: string
path:
type: string
secret-key:
type: string
type: object
config.JWT:
properties:
buffer-time:
description: 缓冲时间
type: string
expires-time:
description: 过期时间
type: string
issuer:
description: 签发者
type: string
signing-key:
description: jwt签名
type: string
type: object
config.Local:
properties:
path:
description: 本地文件访问路径
type: string
store-path:
description: 本地文件存储路径
type: string
type: object
config.MCP:
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
type: object
config.Minio:
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
type: object
config.Mongo:
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: 主机列表
items:
$ref: '#/definitions/config.MongoHost'
type: array
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
type: object
config.MongoHost:
properties:
host:
description: ip地址
type: string
port:
description: 端口
type: string
type: object
config.Mssql:
properties:
config:
description: 高级配置
type: string
db-name:
description: 数据库名
type: string
engine:
default: InnoDB
description: 数据库引擎默认InnoDB
type: string
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
type: object
config.Mysql:
properties:
config:
description: 高级配置
type: string
db-name:
description: 数据库名
type: string
engine:
default: InnoDB
description: 数据库引擎默认InnoDB
type: string
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
type: object
config.Oracle:
properties:
config:
description: 高级配置
type: string
db-name:
description: 数据库名
type: string
engine:
default: InnoDB
description: 数据库引擎默认InnoDB
type: string
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
type: object
config.Pgsql:
properties:
config:
description: 高级配置
type: string
db-name:
description: 数据库名
type: string
engine:
default: InnoDB
description: 数据库引擎默认InnoDB
type: string
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
type: object
config.Qiniu:
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
type: object
config.Redis:
properties:
addr:
description: 服务器地址:端口
type: string
clusterAddrs:
description: 集群模式下的节点地址列表
items:
type: string
type: array
db:
description: 单实例模式下redis的哪个数据库
type: integer
name:
description: 代表当前实例的名字
type: string
password:
description: 密码
type: string
useCluster:
description: 是否使用集群模式
type: boolean
type: object
config.Server:
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:
allOf:
- $ref: '#/definitions/config.CORS'
description: 跨域配置
db-list:
items:
$ref: '#/definitions/config.SpecializedDB'
type: array
disk-list:
items:
$ref: '#/definitions/config.DiskList'
type: array
email:
$ref: '#/definitions/config.Email'
excel:
$ref: '#/definitions/config.Excel'
hua-wei-obs:
$ref: '#/definitions/config.HuaWeiObs'
jwt:
$ref: '#/definitions/config.JWT'
local:
allOf:
- $ref: '#/definitions/config.Local'
description: oss
mcp:
allOf:
- $ref: '#/definitions/config.MCP'
description: MCP配置
minio:
$ref: '#/definitions/config.Minio'
mongo:
$ref: '#/definitions/config.Mongo'
mssql:
$ref: '#/definitions/config.Mssql'
mysql:
allOf:
- $ref: '#/definitions/config.Mysql'
description: gorm
oracle:
$ref: '#/definitions/config.Oracle'
pgsql:
$ref: '#/definitions/config.Pgsql'
qiniu:
$ref: '#/definitions/config.Qiniu'
redis:
$ref: '#/definitions/config.Redis'
redis-list:
items:
$ref: '#/definitions/config.Redis'
type: array
sqlite:
$ref: '#/definitions/config.Sqlite'
system:
$ref: '#/definitions/config.System'
tencent-cos:
$ref: '#/definitions/config.TencentCOS'
zap:
$ref: '#/definitions/config.Zap'
type: object
config.SpecializedDB:
properties:
alias-name:
type: string
config:
description: 高级配置
type: string
db-name:
description: 数据库名
type: string
disable:
type: boolean
engine:
default: InnoDB
description: 数据库引擎默认InnoDB
type: string
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
type: object
config.Sqlite:
properties:
config:
description: 高级配置
type: string
db-name:
description: 数据库名
type: string
engine:
default: InnoDB
description: 数据库引擎默认InnoDB
type: string
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
type: object
config.System:
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
type: object
config.TencentCOS:
properties:
base-url:
type: string
bucket:
type: string
path-prefix:
type: string
region:
type: string
secret-id:
type: string
secret-key:
type: string
type: object
config.Zap:
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
type: object
request.AddMenuAuthorityInfo:
properties:
authorityId:
description: 角色ID
type: integer
menus:
items:
$ref: '#/definitions/system.SysBaseMenu'
type: array
type: object
request.CasbinInReceive:
properties:
authorityId:
description: 权限id
type: integer
casbinInfos:
items:
$ref: '#/definitions/request.CasbinInfo'
type: array
type: object
request.CasbinInfo:
properties:
method:
description: 方法
type: string
path:
description: 路径
type: string
type: object
request.ChangePasswordReq:
properties:
newPassword:
description: 新密码
type: string
password:
description: 密码
type: string
type: object
request.Empty:
type: object
request.ExaAttachmentCategorySearch:
properties:
classId:
type: integer
keyword:
description: 关键字
type: string
page:
description: 页码
type: integer
pageSize:
description: 每页大小
type: integer
type: object
request.GetAuthorityId:
properties:
authorityId:
description: 角色ID
type: integer
type: object
request.GetById:
properties:
id:
description: 主键ID
type: integer
type: object
request.GetUserList:
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
type: object
request.IdsReq:
properties:
ids:
items:
type: integer
type: array
type: object
request.ImportSysDictionaryRequest:
properties:
json:
description: JSON字符串
type: string
required:
- json
type: object
request.InitDB:
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
required:
- adminPassword
- dbName
type: object
request.Login:
properties:
captcha:
description: 验证码
type: string
captchaId:
description: 验证码ID
type: string
password:
description: 密码
type: string
username:
description: 用户名
type: string
type: object
request.PageInfo:
properties:
keyword:
description: 关键字
type: string
page:
description: 页码
type: integer
pageSize:
description: 每页大小
type: integer
type: object
request.Register:
properties:
authorityId:
example: int 角色id
type: string
authorityIds:
example: '[]uint 角色id'
type: string
email:
example: 电子邮箱
type: string
enable:
example: int 是否启用
type: string
headerImg:
example: 头像链接
type: string
nickName:
example: 昵称
type: string
passWord:
example: 密码
type: string
phone:
example: 电话号码
type: string
userName:
example: 用户名
type: string
type: object
request.SearchApiParams:
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
type: object
request.SetApiAuthorities:
properties:
authorityIds:
description: 角色ID列表
items:
type: integer
type: array
method:
description: 请求方法
type: string
path:
description: API路径
type: string
type: object
request.SetMenuAuthorities:
properties:
authorityIds:
description: 角色ID列表
items:
type: integer
type: array
menuId:
description: 菜单ID
type: integer
type: object
request.SetRoleUsers:
properties:
authorityId:
description: 角色ID
type: integer
userIds:
description: 用户ID列表
items:
type: integer
type: array
type: object
request.SetUserAuth:
properties:
authorityId:
description: 角色ID
type: integer
type: object
request.SetUserAuthorities:
properties:
authorityIds:
description: 角色ID
items:
type: integer
type: array
id:
type: integer
type: object
request.SysAuthorityBtnReq:
properties:
authorityId:
type: integer
menuID:
type: integer
selected:
items:
type: integer
type: array
type: object
response.ExaFileResponse:
properties:
file:
$ref: '#/definitions/common.ExaFileUploadAndDownload'
type: object
response.FilePathResponse:
properties:
filePath:
type: string
type: object
response.FileResponse:
properties:
file:
$ref: '#/definitions/common.ExaFile'
type: object
response.LoginResponse:
properties:
expiresAt:
type: integer
token:
type: string
user:
$ref: '#/definitions/system.SysUser'
type: object
response.PageResult:
properties:
list: {}
page:
type: integer
pageSize:
type: integer
total:
type: integer
type: object
response.PolicyPathResponse:
properties:
paths:
items:
$ref: '#/definitions/request.CasbinInfo'
type: array
type: object
response.Response:
properties:
code:
type: integer
data: {}
msg:
type: string
type: object
response.SysAPIListResponse:
properties:
apis:
items:
$ref: '#/definitions/system.SysApi'
type: array
type: object
response.SysAPIResponse:
properties:
api:
$ref: '#/definitions/system.SysApi'
type: object
response.SysAuthorityBtnRes:
properties:
selected:
items:
type: integer
type: array
type: object
response.SysAuthorityCopyResponse:
properties:
authority:
$ref: '#/definitions/system.SysAuthority'
oldAuthorityId:
description: 旧角色ID
type: integer
type: object
response.SysAuthorityResponse:
properties:
authority:
$ref: '#/definitions/system.SysAuthority'
type: object
response.SysBaseMenuResponse:
properties:
menu:
$ref: '#/definitions/system.SysBaseMenu'
type: object
response.SysBaseMenusResponse:
properties:
menus:
items:
$ref: '#/definitions/system.SysBaseMenu'
type: array
type: object
response.SysCaptchaResponse:
properties:
captchaId:
type: string
captchaLength:
type: integer
openCaptcha:
type: boolean
picPath:
type: string
type: object
response.SysConfigResponse:
properties:
config:
$ref: '#/definitions/config.Server'
type: object
response.SysMenusResponse:
properties:
menus:
items:
$ref: '#/definitions/system.SysMenu'
type: array
type: object
response.SysUserResponse:
properties:
user:
$ref: '#/definitions/system.SysUser'
type: object
system.Meta:
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
type: object
system.SysApi:
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
type: object
system.SysAuthority:
properties:
authorityId:
description: 角色ID
type: integer
authorityName:
description: 角色名
type: string
children:
items:
$ref: '#/definitions/system.SysAuthority'
type: array
createdAt:
description: 创建时间
type: string
dataAuthorityId:
items:
$ref: '#/definitions/system.SysAuthority'
type: array
defaultRouter:
description: 默认菜单(默认dashboard)
type: string
deletedAt:
type: string
menus:
items:
$ref: '#/definitions/system.SysBaseMenu'
type: array
parentId:
description: 父角色ID
type: integer
updatedAt:
description: 更新时间
type: string
type: object
system.SysBaseMenu:
properties:
ID:
description: 主键ID
type: integer
authoritys:
items:
$ref: '#/definitions/system.SysAuthority'
type: array
children:
items:
$ref: '#/definitions/system.SysBaseMenu'
type: array
component:
description: 对应前端文件路径
type: string
createdAt:
description: 创建时间
type: string
hidden:
description: 是否在列表隐藏
type: boolean
menuBtn:
items:
$ref: '#/definitions/system.SysBaseMenuBtn'
type: array
meta:
allOf:
- $ref: '#/definitions/system.Meta'
description: 附加属性
name:
description: 路由name
type: string
parameters:
items:
$ref: '#/definitions/system.SysBaseMenuParameter'
type: array
parentId:
description: 父菜单ID
type: integer
path:
description: 路由path
type: string
sort:
description: 排序标记
type: integer
updatedAt:
description: 更新时间
type: string
type: object
system.SysBaseMenuBtn:
properties:
ID:
description: 主键ID
type: integer
createdAt:
description: 创建时间
type: string
desc:
type: string
name:
type: string
sysBaseMenuID:
type: integer
updatedAt:
description: 更新时间
type: string
type: object
system.SysBaseMenuParameter:
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
type: object
system.SysDictionary:
properties:
ID:
description: 主键ID
type: integer
children:
description: 子字典
items:
$ref: '#/definitions/system.SysDictionary'
type: array
createdAt:
description: 创建时间
type: string
desc:
description: 描述
type: string
name:
description: 字典名(中)
type: string
parentID:
description: 父级字典ID
type: integer
status:
description: 状态
type: boolean
sysDictionaryDetails:
items:
$ref: '#/definitions/system.SysDictionaryDetail'
type: array
type:
description: 字典名(英)
type: string
updatedAt:
description: 更新时间
type: string
type: object
system.SysDictionaryDetail:
properties:
ID:
description: 主键ID
type: integer
children:
description: 子字典详情
items:
$ref: '#/definitions/system.SysDictionaryDetail'
type: array
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
type: object
system.SysError:
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
required:
- form
type: object
system.SysMenu:
properties:
ID:
description: 主键ID
type: integer
authoritys:
items:
$ref: '#/definitions/system.SysAuthority'
type: array
btns:
additionalProperties:
type: integer
type: object
children:
items:
$ref: '#/definitions/system.SysMenu'
type: array
component:
description: 对应前端文件路径
type: string
createdAt:
description: 创建时间
type: string
hidden:
description: 是否在列表隐藏
type: boolean
menuBtn:
items:
$ref: '#/definitions/system.SysBaseMenuBtn'
type: array
menuId:
type: integer
meta:
allOf:
- $ref: '#/definitions/system.Meta'
description: 附加属性
name:
description: 路由name
type: string
parameters:
items:
$ref: '#/definitions/system.SysBaseMenuParameter'
type: array
parentId:
description: 父菜单ID
type: integer
path:
description: 路由path
type: string
sort:
description: 排序标记
type: integer
updatedAt:
description: 更新时间
type: string
type: object
system.SysOperationRecord:
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
type: object
system.SysParams:
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
required:
- key
- name
- value
type: object
system.SysUser:
properties:
ID:
description: 主键ID
type: integer
authorities:
description: 多用户角色
items:
$ref: '#/definitions/system.SysAuthority'
type: array
authority:
allOf:
- $ref: '#/definitions/system.SysAuthority'
description: 用户角色
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:
allOf:
- $ref: '#/definitions/common.JSONMap'
description: 配置
phone:
description: 用户手机号
type: string
updatedAt:
description: 更新时间
type: string
userName:
description: 用户登录名
type: string
uuid:
description: 用户UUID
type: string
type: object
system.System:
properties:
config:
$ref: '#/definitions/config.Server'
type: object
info:
contact: {}
description: 使用gin+react进行极速开发的全栈开发基础平台
title: Gin-React-Admin Swagger API接口文档
version: v2.9.1
paths:
/api/createApi:
post:
consumes:
- application/json
parameters:
- description: api路径, api中文描述, api组, 方法
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysApi'
produces:
- application/json
responses:
"200":
description: 创建基础api
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建基础api
tags:
- SysApi
/api/deleteApi:
post:
consumes:
- application/json
parameters:
- description: ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysApi'
produces:
- application/json
responses:
"200":
description: 删除api
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除api
tags:
- SysApi
/api/deleteApisByIds:
delete:
consumes:
- application/json
parameters:
- description: ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: 删除选中Api
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除选中Api
tags:
- SysApi
/api/enterSyncApi:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 确认同步API
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 确认同步API
tags:
- SysApi
/api/freshCasbin:
get:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 刷新成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
summary: 刷新casbin缓存
tags:
- SysApi
/api/getAllApis:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 获取所有的Api 不分页,返回包括api列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysAPIListResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取所有的Api 不分页
tags:
- SysApi
/api/getApiById:
post:
consumes:
- application/json
parameters:
- description: 根据id获取api
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetById'
produces:
- application/json
responses:
"200":
description: 根据id获取api,返回包括api详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysAPIResponse'
type: object
security:
- ApiKeyAuth: []
summary: 根据id获取api
tags:
- SysApi
/api/getApiGroups:
get:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 获取API分组
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取API分组
tags:
- SysApi
/api/getApiList:
post:
consumes:
- application/json
parameters:
- description: 分页获取API列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SearchApiParams'
produces:
- application/json
responses:
"200":
description: 分页获取API列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取API列表
tags:
- SysApi
/api/getApiRoles:
get:
consumes:
- application/json
parameters:
- description: API路径
in: query
name: path
required: true
type: string
- description: 请求方法
in: query
name: method
required: true
type: string
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取拥有指定API权限的角色ID列表
tags:
- SysApi
/api/ignoreApi:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 同步API
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 忽略API
tags:
- IgnoreApi
/api/setApiRoles:
post:
consumes:
- application/json
parameters:
- description: API路径、请求方法和角色ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SetApiAuthorities'
produces:
- application/json
responses:
"200":
description: 设置成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 全量覆盖某API关联的角色列表
tags:
- SysApi
/api/syncApi:
get:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 同步API
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 同步API
tags:
- SysApi
/api/updateApi:
post:
consumes:
- application/json
parameters:
- description: api路径, api中文描述, api组, 方法
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysApi'
produces:
- application/json
responses:
"200":
description: 修改基础api
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 修改基础api
tags:
- SysApi
/attachmentCategory/addCategory:
post:
consumes:
- application/json
parameters:
- description: 媒体库分类数据
in: body
name: data
required: true
schema:
$ref: '#/definitions/common.ExaAttachmentCategory'
produces:
- application/json
responses: {}
security:
- AttachmentCategory: []
summary: 添加媒体库分类
tags:
- AddCategory
/attachmentCategory/deleteCategory:
post:
consumes:
- application/json
parameters:
- description: 分类id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetById'
produces:
- application/json
responses:
"200":
description: 删除分类
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- AttachmentCategory: []
summary: 删除分类
tags:
- DeleteCategory
/attachmentCategory/getCategoryList:
get:
produces:
- application/json
responses:
"200":
description: 媒体库分类列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/common.ExaAttachmentCategory'
msg:
type: string
type: object
security:
- AttachmentCategory: []
summary: 媒体库分类列表
tags:
- GetCategoryList
/authority/copyAuthority:
post:
consumes:
- application/json
parameters:
- description: 旧角色id, 新权限id, 新权限名, 新父角色id
in: body
name: data
required: true
schema:
$ref: '#/definitions/response.SysAuthorityCopyResponse'
produces:
- application/json
responses:
"200":
description: 拷贝角色,返回包括系统角色详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysAuthorityResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 拷贝角色
tags:
- Authority
/authority/createAuthority:
post:
consumes:
- application/json
parameters:
- description: 权限id, 权限名, 父角色id
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysAuthority'
produces:
- application/json
responses:
"200":
description: 创建角色,返回包括系统角色详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysAuthorityResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建角色
tags:
- Authority
/authority/deleteAuthority:
post:
consumes:
- application/json
parameters:
- description: 删除角色
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysAuthority'
produces:
- application/json
responses:
"200":
description: 删除角色
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除角色
tags:
- Authority
/authority/getAuthorityList:
post:
consumes:
- application/json
parameters:
- description: 页码, 每页大小
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageInfo'
produces:
- application/json
responses:
"200":
description: 分页获取角色列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取角色列表
tags:
- Authority
/authority/getUsersByAuthority:
get:
consumes:
- application/json
parameters:
- description: 角色ID
in: query
name: authorityId
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
type: integer
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取拥有指定角色的用户ID列表
tags:
- Authority
/authority/setDataAuthority:
post:
consumes:
- application/json
parameters:
- description: 设置角色资源权限
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysAuthority'
produces:
- application/json
responses:
"200":
description: 设置角色资源权限
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置角色资源权限
tags:
- Authority
/authority/setRoleUsers:
post:
consumes:
- application/json
parameters:
- description: 角色ID和用户ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SetRoleUsers'
produces:
- application/json
responses:
"200":
description: 设置成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 全量覆盖某角色关联的用户列表
tags:
- Authority
/authority/updateAuthority:
put:
consumes:
- application/json
parameters:
- description: 权限id, 权限名, 父角色id
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysAuthority'
produces:
- application/json
responses:
"200":
description: 更新角色信息,返回包括系统角色详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysAuthorityResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新角色信息
tags:
- Authority
/authorityBtn/canRemoveAuthorityBtn:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 删除成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置权限按钮
tags:
- AuthorityBtn
/authorityBtn/getAuthorityBtn:
post:
consumes:
- application/json
parameters:
- description: 菜单id, 角色id, 选中的按钮id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SysAuthorityBtnReq'
produces:
- application/json
responses:
"200":
description: 返回列表成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysAuthorityBtnRes'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取权限按钮
tags:
- AuthorityBtn
/authorityBtn/setAuthorityBtn:
post:
consumes:
- application/json
parameters:
- description: 菜单id, 角色id, 选中的按钮id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SysAuthorityBtnReq'
produces:
- application/json
responses:
"200":
description: 返回列表成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置权限按钮
tags:
- AuthorityBtn
/base/captcha:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 生成验证码,返回包括随机数id,base64,验证码长度,是否开启验证码
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysCaptchaResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 生成验证码
tags:
- Base
/base/login:
post:
parameters:
- description: 用户名, 密码, 验证码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.Login'
produces:
- application/json
responses:
"200":
description: 返回包括用户信息,token,过期时间
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.LoginResponse'
msg:
type: string
type: object
summary: 用户登录
tags:
- Base
/casbin/UpdateCasbin:
post:
consumes:
- application/json
parameters:
- description: 权限id, 权限模型列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CasbinInReceive'
produces:
- application/json
responses:
"200":
description: 更新角色api权限
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新角色api权限
tags:
- Casbin
/casbin/getPolicyPathByAuthorityId:
post:
consumes:
- application/json
parameters:
- description: 权限id, 权限模型列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CasbinInReceive'
produces:
- application/json
responses:
"200":
description: 获取权限列表,返回包括casbin详情列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PolicyPathResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取权限列表
tags:
- Casbin
/fileUploadAndDownload/breakpointContinue:
post:
consumes:
- multipart/form-data
parameters:
- description: an example for breakpoint resume, 断点续传示例
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 断点续传到服务器
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 断点续传到服务器
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/deleteFile:
post:
parameters:
- description: 传入文件里面id即可
in: body
name: data
required: true
schema:
$ref: '#/definitions/common.ExaFileUploadAndDownload'
produces:
- application/json
responses:
"200":
description: 删除文件
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除文件
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/findFile:
get:
consumes:
- multipart/form-data
parameters:
- description: Find the file, 查找文件
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 查找文件,返回包括文件详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.FileResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 查找文件
tags:
- ExaFileUploadAndDownload
post:
consumes:
- multipart/form-data
parameters:
- description: 上传文件完成
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 创建文件,返回包括文件路径
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.FilePathResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建文件
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/getFileList:
post:
consumes:
- application/json
parameters:
- description: 页码, 每页大小, 分类id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.ExaAttachmentCategorySearch'
produces:
- application/json
responses:
"200":
description: 分页文件列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页文件列表
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/importURL:
post:
parameters:
- description: 对象
in: body
name: data
required: true
schema:
$ref: '#/definitions/common.ExaFileUploadAndDownload'
produces:
- application/json
responses:
"200":
description: 导入URL
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 导入URL
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/removeChunk:
post:
consumes:
- multipart/form-data
parameters:
- description: 删除缓存切片
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 删除切片
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除切片
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/upload:
post:
consumes:
- multipart/form-data
parameters:
- description: 上传文件示例
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 上传文件示例,返回包括文件详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.ExaFileResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 上传文件示例
tags:
- ExaFileUploadAndDownload
/init/checkdb:
post:
produces:
- application/json
responses:
"200":
description: 初始化用户数据库
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
summary: 初始化用户数据库
tags:
- CheckDB
/init/initdb:
post:
parameters:
- description: 初始化数据库参数
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.InitDB'
produces:
- application/json
responses:
"200":
description: 初始化用户数据库
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: string
type: object
summary: 初始化用户数据库
tags:
- InitDB
/jwt/jsonInBlacklist:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: jwt加入黑名单
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: jwt加入黑名单
tags:
- Jwt
/menu/addBaseMenu:
post:
consumes:
- application/json
parameters:
- description: 路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysBaseMenu'
produces:
- application/json
responses:
"200":
description: 新增菜单
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 新增菜单
tags:
- Menu
/menu/addMenuAuthority:
post:
consumes:
- application/json
parameters:
- description: 角色ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.AddMenuAuthorityInfo'
produces:
- application/json
responses:
"200":
description: 增加menu和角色关联关系
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 增加menu和角色关联关系
tags:
- AuthorityMenu
/menu/deleteBaseMenu:
post:
consumes:
- application/json
parameters:
- description: 菜单id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetById'
produces:
- application/json
responses:
"200":
description: 删除菜单
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除菜单
tags:
- Menu
/menu/getBaseMenuById:
post:
consumes:
- application/json
parameters:
- description: 菜单id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetById'
produces:
- application/json
responses:
"200":
description: 根据id获取菜单,返回包括系统菜单列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysBaseMenuResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 根据id获取菜单
tags:
- Menu
/menu/getBaseMenuTree:
post:
parameters:
- description:
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.Empty'
produces:
- application/json
responses:
"200":
description: 获取用户动态路由,返回包括系统菜单列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysBaseMenusResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取用户动态路由
tags:
- AuthorityMenu
/menu/getMenu:
post:
parameters:
- description:
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.Empty'
produces:
- application/json
responses:
"200":
description: 获取用户动态路由,返回包括系统菜单详情列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysMenusResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取用户动态路由
tags:
- AuthorityMenu
/menu/getMenuAuthority:
post:
consumes:
- application/json
parameters:
- description: 角色ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetAuthorityId'
produces:
- application/json
responses:
"200":
description: 获取指定角色menu
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取指定角色menu
tags:
- AuthorityMenu
/menu/getMenuList:
post:
consumes:
- application/json
parameters:
- description: 页码, 每页大小
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageInfo'
produces:
- application/json
responses:
"200":
description: 分页获取基础menu列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取基础menu列表
tags:
- Menu
/menu/getMenuRoles:
get:
consumes:
- application/json
parameters:
- description: 菜单ID
in: query
name: menuId
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取拥有指定菜单的角色ID列表
tags:
- AuthorityMenu
/menu/setMenuRoles:
post:
consumes:
- application/json
parameters:
- description: 菜单ID和角色ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SetMenuAuthorities'
produces:
- application/json
responses:
"200":
description: 设置成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 全量覆盖某菜单关联的角色列表
tags:
- AuthorityMenu
/menu/updateBaseMenu:
post:
consumes:
- application/json
parameters:
- description: 路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysBaseMenu'
produces:
- application/json
responses:
"200":
description: 更新菜单
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新菜单
tags:
- Menu
/sysDictionary/createSysDictionary:
post:
consumes:
- application/json
parameters:
- description: SysDictionary模型
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysDictionary'
produces:
- application/json
responses:
"200":
description: 创建SysDictionary
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建SysDictionary
tags:
- SysDictionary
/sysDictionary/deleteSysDictionary:
delete:
consumes:
- application/json
parameters:
- description: SysDictionary模型
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysDictionary'
produces:
- application/json
responses:
"200":
description: 删除SysDictionary
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除SysDictionary
tags:
- SysDictionary
/sysDictionary/exportSysDictionary:
get:
consumes:
- application/json
parameters:
- description: 主键ID
in: query
name: ID
type: integer
- description: 创建时间
in: query
name: createdAt
type: string
- description: 描述
in: query
name: desc
type: string
- description: 字典名(中)
in: query
name: name
type: string
- description: 父级字典ID
in: query
name: parentID
type: integer
- description: 状态
in: query
name: status
type: boolean
- description: 字典名(英)
in: query
name: type
type: string
- description: 更新时间
in: query
name: updatedAt
type: string
produces:
- application/json
responses:
"200":
description: 导出字典JSON
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 导出字典JSON包含字典详情
tags:
- SysDictionary
/sysDictionary/findSysDictionary:
get:
consumes:
- application/json
parameters:
- description: 主键ID
in: query
name: ID
type: integer
- description: 创建时间
in: query
name: createdAt
type: string
- description: 描述
in: query
name: desc
type: string
- description: 字典名(中)
in: query
name: name
type: string
- description: 父级字典ID
in: query
name: parentID
type: integer
- description: 状态
in: query
name: status
type: boolean
- description: 字典名(英)
in: query
name: type
type: string
- description: 更新时间
in: query
name: updatedAt
type: string
produces:
- application/json
responses:
"200":
description: 用id查询SysDictionary
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用id查询SysDictionary
tags:
- SysDictionary
/sysDictionary/getSysDictionaryList:
get:
consumes:
- application/json
parameters:
- description: 字典名(中)
in: query
name: name
type: string
produces:
- application/json
responses:
"200":
description: 分页获取SysDictionary列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取SysDictionary列表
tags:
- SysDictionary
/sysDictionary/importSysDictionary:
post:
consumes:
- application/json
parameters:
- description: 字典JSON数据
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.ImportSysDictionaryRequest'
produces:
- application/json
responses:
"200":
description: 导入字典
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 导入字典JSON包含字典详情
tags:
- SysDictionary
/sysDictionary/updateSysDictionary:
put:
consumes:
- application/json
parameters:
- description: SysDictionary模型
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysDictionary'
produces:
- application/json
responses:
"200":
description: 更新SysDictionary
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新SysDictionary
tags:
- SysDictionary
/sysDictionaryDetail/createSysDictionaryDetail:
post:
consumes:
- application/json
parameters:
- description: SysDictionaryDetail模型
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysDictionaryDetail'
produces:
- application/json
responses:
"200":
description: 创建SysDictionaryDetail
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建SysDictionaryDetail
tags:
- SysDictionaryDetail
/sysDictionaryDetail/deleteSysDictionaryDetail:
delete:
consumes:
- application/json
parameters:
- description: SysDictionaryDetail模型
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysDictionaryDetail'
produces:
- application/json
responses:
"200":
description: 删除SysDictionaryDetail
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除SysDictionaryDetail
tags:
- SysDictionaryDetail
/sysDictionaryDetail/findSysDictionaryDetail:
get:
consumes:
- application/json
parameters:
- description: 主键ID
in: query
name: ID
type: integer
- description: 创建时间
in: query
name: createdAt
type: string
- description: 禁用状态根据status字段动态计算
in: query
name: disabled
type: boolean
- description: 扩展值
in: query
name: extend
type: string
- description: 展示值
in: query
name: label
type: string
- description: 层级深度从0开始
in: query
name: level
type: integer
- description: 父级字典详情ID
in: query
name: parentID
type: integer
- description: 层级路径,如 "1,2,3"
in: query
name: path
type: string
- description: 排序标记
in: query
name: sort
type: integer
- description: 启用状态
in: query
name: status
type: boolean
- description: 关联标记
in: query
name: sysDictionaryID
type: integer
- description: 更新时间
in: query
name: updatedAt
type: string
- description: 字典值
in: query
name: value
type: string
produces:
- application/json
responses:
"200":
description: 用id查询SysDictionaryDetail
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用id查询SysDictionaryDetail
tags:
- SysDictionaryDetail
/sysDictionaryDetail/getDictionaryDetailsByParent:
get:
consumes:
- application/json
parameters:
- description: 是否包含子级数据
in: query
name: includeChildren
type: boolean
- description: 父级字典详情ID为空时获取顶级
in: query
name: parentID
type: integer
- description: 字典ID
in: query
name: sysDictionaryID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 获取字典详情列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/system.SysDictionaryDetail'
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 根据父级ID获取字典详情
tags:
- SysDictionaryDetail
/sysDictionaryDetail/getDictionaryPath:
get:
consumes:
- application/json
parameters:
- description: 字典详情ID
in: query
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 获取字典详情路径
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/system.SysDictionaryDetail'
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取字典详情的完整路径
tags:
- SysDictionaryDetail
/sysDictionaryDetail/getDictionaryTreeList:
get:
consumes:
- application/json
parameters:
- description: 字典ID
in: query
name: sysDictionaryID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 获取字典详情树形结构
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/system.SysDictionaryDetail'
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取字典详情树形结构
tags:
- SysDictionaryDetail
/sysDictionaryDetail/getDictionaryTreeListByType:
get:
consumes:
- application/json
parameters:
- description: 字典类型
in: query
name: type
required: true
type: string
produces:
- application/json
responses:
"200":
description: 获取字典详情树形结构
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/system.SysDictionaryDetail'
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 根据字典类型获取字典详情树形结构
tags:
- SysDictionaryDetail
/sysDictionaryDetail/getSysDictionaryDetailList:
get:
consumes:
- application/json
parameters:
- description: 主键ID
in: query
name: ID
type: integer
- description: 创建时间
in: query
name: createdAt
type: string
- description: 禁用状态根据status字段动态计算
in: query
name: disabled
type: boolean
- description: 扩展值
in: query
name: extend
type: string
- description: 关键字
in: query
name: keyword
type: string
- description: 展示值
in: query
name: label
type: string
- description: 层级深度,用于查询指定层级的数据
in: query
name: level
type: integer
- description: 页码
in: query
name: page
type: integer
- description: 每页大小
in: query
name: pageSize
type: integer
- description: 父级字典详情ID用于查询指定父级下的子项
in: query
name: parentID
type: integer
- description: 层级路径,如 "1,2,3"
in: query
name: path
type: string
- description: 排序标记
in: query
name: sort
type: integer
- description: 启用状态
in: query
name: status
type: boolean
- description: 关联标记
in: query
name: sysDictionaryID
type: integer
- description: 更新时间
in: query
name: updatedAt
type: string
- description: 字典值
in: query
name: value
type: string
produces:
- application/json
responses:
"200":
description: 分页获取SysDictionaryDetail列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取SysDictionaryDetail列表
tags:
- SysDictionaryDetail
/sysDictionaryDetail/updateSysDictionaryDetail:
put:
consumes:
- application/json
parameters:
- description: 更新SysDictionaryDetail
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysDictionaryDetail'
produces:
- application/json
responses:
"200":
description: 更新SysDictionaryDetail
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新SysDictionaryDetail
tags:
- SysDictionaryDetail
/sysError/createSysError:
post:
consumes:
- application/json
parameters:
- description: 创建错误日志
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysError'
produces:
- application/json
responses:
"200":
description: 创建成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建错误日志
tags:
- SysError
/sysError/deleteSysError:
delete:
consumes:
- application/json
parameters:
- description: 删除错误日志
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysError'
produces:
- application/json
responses:
"200":
description: 删除成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除错误日志
tags:
- SysError
/sysError/deleteSysErrorByIds:
delete:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 批量删除成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 批量删除错误日志
tags:
- SysError
/sysError/findSysError:
get:
consumes:
- application/json
parameters:
- description: 用id查询错误日志
in: query
name: ID
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 查询成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.SysError'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用id查询错误日志
tags:
- SysError
/sysError/getSysErrorList:
get:
consumes:
- application/json
parameters:
- collectionFormat: csv
in: query
items:
type: string
name: createdAtRange
type: array
- in: query
name: form
type: string
- in: query
name: info
type: string
- description: 关键字
in: query
name: keyword
type: string
- description: 页码
in: query
name: page
type: integer
- description: 每页大小
in: query
name: pageSize
type: integer
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取错误日志列表
tags:
- SysError
/sysError/getSysErrorSolution:
get:
consumes:
- application/json
parameters:
- description: 错误日志ID
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 处理已提交
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 根据ID触发处理标记为处理中1分钟后自动改为处理完成
tags:
- SysError
/sysError/updateSysError:
put:
consumes:
- application/json
parameters:
- description: 更新错误日志
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysError'
produces:
- application/json
responses:
"200":
description: 更新成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新错误日志
tags:
- SysError
/sysOperationRecord/deleteSysOperationRecord:
delete:
consumes:
- application/json
parameters:
- description: SysOperationRecord模型
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysOperationRecord'
produces:
- application/json
responses:
"200":
description: 删除SysOperationRecord
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除SysOperationRecord
tags:
- SysOperationRecord
/sysOperationRecord/deleteSysOperationRecordByIds:
delete:
consumes:
- application/json
parameters:
- description: 批量删除SysOperationRecord
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: 批量删除SysOperationRecord
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 批量删除SysOperationRecord
tags:
- SysOperationRecord
/sysOperationRecord/findSysOperationRecord:
get:
consumes:
- application/json
parameters:
- description: 主键ID
in: query
name: ID
type: integer
- description: 代理
in: query
name: agent
type: string
- description: 请求Body
in: query
name: body
type: string
- description: 创建时间
in: query
name: createdAt
type: string
- description: 错误信息
in: query
name: error_message
type: string
- description: 请求ip
in: query
name: ip
type: string
- description: 延迟
in: query
name: latency
type: string
- description: 请求方法
in: query
name: method
type: string
- description: 请求路径
in: query
name: path
type: string
- description: 响应Body
in: query
name: resp
type: string
- description: 请求状态
in: query
name: status
type: integer
- description: 更新时间
in: query
name: updatedAt
type: string
- description: 用户id
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: 用id查询SysOperationRecord
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用id查询SysOperationRecord
tags:
- SysOperationRecord
/sysOperationRecord/getSysOperationRecordList:
get:
consumes:
- application/json
parameters:
- description: 主键ID
in: query
name: ID
type: integer
- description: 代理
in: query
name: agent
type: string
- description: 请求Body
in: query
name: body
type: string
- description: 创建时间
in: query
name: createdAt
type: string
- description: 错误信息
in: query
name: error_message
type: string
- description: 请求ip
in: query
name: ip
type: string
- description: 关键字
in: query
name: keyword
type: string
- description: 延迟
in: query
name: latency
type: string
- description: 请求方法
in: query
name: method
type: string
- description: 页码
in: query
name: page
type: integer
- description: 每页大小
in: query
name: pageSize
type: integer
- description: 请求路径
in: query
name: path
type: string
- description: 响应Body
in: query
name: resp
type: string
- description: 请求状态
in: query
name: status
type: integer
- description: 更新时间
in: query
name: updatedAt
type: string
- description: 用户id
in: query
name: user_id
type: integer
produces:
- application/json
responses:
"200":
description: 分页获取SysOperationRecord列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取SysOperationRecord列表
tags:
- SysOperationRecord
/sysParams/createSysParams:
post:
consumes:
- application/json
parameters:
- description: 创建参数
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysParams'
produces:
- application/json
responses:
"200":
description: 创建成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建参数
tags:
- SysParams
/sysParams/deleteSysParams:
delete:
consumes:
- application/json
parameters:
- description: 删除参数
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysParams'
produces:
- application/json
responses:
"200":
description: 删除成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除参数
tags:
- SysParams
/sysParams/deleteSysParamsByIds:
delete:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 批量删除成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 批量删除参数
tags:
- SysParams
/sysParams/findSysParams:
get:
consumes:
- application/json
parameters:
- description: 主键ID
in: query
name: ID
type: integer
- description: 创建时间
in: query
name: createdAt
type: string
- description: 参数说明
in: query
name: desc
type: string
- description: 参数键
in: query
name: key
required: true
type: string
- description: 参数名称
in: query
name: name
required: true
type: string
- description: 更新时间
in: query
name: updatedAt
type: string
- description: 参数值
in: query
name: value
required: true
type: string
produces:
- application/json
responses:
"200":
description: 查询成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.SysParams'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用id查询参数
tags:
- SysParams
/sysParams/getSysParam:
get:
consumes:
- application/json
parameters:
- description: key
in: query
name: key
required: true
type: string
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.SysParams'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 根据key获取参数value
tags:
- SysParams
/sysParams/getSysParamsList:
get:
consumes:
- application/json
parameters:
- in: query
name: endCreatedAt
type: string
- in: query
name: key
type: string
- description: 关键字
in: query
name: keyword
type: string
- in: query
name: name
type: string
- description: 页码
in: query
name: page
type: integer
- description: 每页大小
in: query
name: pageSize
type: integer
- in: query
name: startCreatedAt
type: string
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取参数列表
tags:
- SysParams
/sysParams/updateSysParams:
put:
consumes:
- application/json
parameters:
- description: 更新参数
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysParams'
produces:
- application/json
responses:
"200":
description: 更新成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新参数
tags:
- SysParams
/system/getServerInfo:
post:
produces:
- application/json
responses:
"200":
description: 获取服务器信息
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取服务器信息
tags:
- System
/system/getSystemConfig:
post:
produces:
- application/json
responses:
"200":
description: 获取配置文件内容,返回包括系统配置
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysConfigResponse'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取配置文件内容
tags:
- System
/system/reloadSystem:
post:
produces:
- application/json
responses:
"200":
description: 重载系统
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 重载系统
tags:
- System
/system/setSystemConfig:
post:
parameters:
- description: 设置配置文件内容
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.System'
produces:
- application/json
responses:
"200":
description: 设置配置文件内容
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置配置文件内容
tags:
- System
/user/SetSelfInfo:
put:
consumes:
- application/json
parameters:
- description: ID, 用户名, 昵称, 头像链接
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysUser'
produces:
- application/json
responses:
"200":
description: 设置用户信息
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置用户信息
tags:
- SysUser
/user/SetSelfSetting:
put:
consumes:
- application/json
parameters:
- description: 用户配置数据
in: body
name: data
required: true
schema:
additionalProperties: true
type: object
produces:
- application/json
responses:
"200":
description: 设置用户配置
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置用户配置
tags:
- SysUser
/user/admin_register:
post:
parameters:
- description: 用户名, 昵称, 密码, 角色ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.Register'
produces:
- application/json
responses:
"200":
description: 用户注册账号,返回包括用户信息
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.SysUserResponse'
msg:
type: string
type: object
summary: 用户注册账号
tags:
- SysUser
/user/changePassword:
post:
parameters:
- description: 用户名, 原密码, 新密码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.ChangePasswordReq'
produces:
- application/json
responses:
"200":
description: 用户修改密码
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用户修改密码
tags:
- SysUser
/user/deleteUser:
delete:
consumes:
- application/json
parameters:
- description: 用户ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetById'
produces:
- application/json
responses:
"200":
description: 删除用户
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除用户
tags:
- SysUser
/user/getUserInfo:
get:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: 获取用户信息
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取用户信息
tags:
- SysUser
/user/getUserList:
post:
consumes:
- application/json
parameters:
- description: 页码, 每页大小
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetUserList'
produces:
- application/json
responses:
"200":
description: 分页获取用户列表,返回包括列表,总数,页码,每页数量
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 分页获取用户列表
tags:
- SysUser
/user/resetPassword:
post:
parameters:
- description: ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysUser'
produces:
- application/json
responses:
"200":
description: 重置用户密码
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 重置用户密码
tags:
- SysUser
/user/setUserAuthorities:
post:
consumes:
- application/json
parameters:
- description: 用户UUID, 角色ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SetUserAuthorities'
produces:
- application/json
responses:
"200":
description: 设置用户权限
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置用户权限
tags:
- SysUser
/user/setUserAuthority:
post:
consumes:
- application/json
parameters:
- description: 用户UUID, 角色ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.SetUserAuth'
produces:
- application/json
responses:
"200":
description: 设置用户权限
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更改用户权限
tags:
- SysUser
/user/setUserInfo:
put:
consumes:
- application/json
parameters:
- description: ID, 用户名, 昵称, 头像链接
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.SysUser'
produces:
- application/json
responses:
"200":
description: 设置用户信息
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置用户信息
tags:
- SysUser
securityDefinitions:
ApiKeyAuth:
in: header
name: x-token
type: apiKey
swagger: "2.0"
tags:
- name: Base
- description: 用户
name: SysUser