DeployHelper/api/swagger.yaml

2743 lines
63 KiB
YAML
Raw Normal View History

2025-08-01 16:38:08 +08:00
basePath: /
definitions:
model.MenuMeta:
properties:
icon:
type: string
title:
$ref: '#/definitions/model.Title'
type: object
model.SysConfig:
properties:
configID:
type: string
configKey:
type: string
configName:
type: string
configType:
type: string
configValue:
type: string
createBy:
type: string
createTime:
type: string
remark:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysDept:
properties:
ancestors:
type: string
createBy:
type: string
createTime:
type: string
delFlag:
type: string
deptId:
type: string
deptName:
type: string
email:
type: string
leader:
type: string
orderNum:
type: integer
parentId:
type: string
phone:
type: string
status:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysDictData:
properties:
createBy:
type: string
createTime:
type: string
cssClass:
type: string
dictCode:
type: string
dictLabel:
type: string
dictSort:
type: integer
dictType:
type: string
dictValue:
type: string
isDefault:
type: string
listClass:
type: string
remark:
type: string
status:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysDictType:
properties:
createBy:
type: string
createTime:
type: string
dictId:
type: string
dictName:
type: string
dictType:
type: string
remark:
type: string
status:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysFile:
properties:
businessId:
type: string
businessType:
type: string
createBy:
type: string
createTime:
type: string
delFlag:
type: string
fileKey:
type: string
fileName:
type: string
fileSize:
type: integer
fileType:
type: string
id:
type: string
revision:
type: integer
type:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysJob:
properties:
concurrent:
type: string
createBy:
type: string
createTime:
type: string
cronExpression:
type: string
invokeTarget:
type: string
jobGroup:
type: string
jobId:
type: string
jobName:
type: string
misfirePolicy:
type: string
remark:
type: string
status:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysMenu:
properties:
children:
items:
$ref: '#/definitions/model.SysMenu'
type: array
component:
type: string
createBy:
type: string
createTime:
type: string
en_US:
type: string
frameBlank:
type: boolean
frameSrc:
type: string
icon:
type: string
isCache:
type: string
isFrame:
type: string
menuID:
type: string
menuType:
type: string
meta:
$ref: '#/definitions/model.MenuMeta'
name:
type: string
orderNum:
type: integer
parentID:
type: string
path:
type: string
perms:
type: string
query:
type: string
redirect:
type: string
remark:
type: string
status:
type: string
updateBy:
type: string
updateTime:
type: string
visible:
type: string
zh_CN:
type: string
type: object
model.SysNotice:
properties:
createBy:
type: string
createTime:
type: string
noticeContent:
type: string
noticeId:
type: string
noticeTitle:
type: string
noticeType:
type: string
remark:
type: string
status:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysOperLog:
properties:
businessType:
type: integer
deptName:
type: string
errorMsg:
type: string
jsonResult:
type: string
method:
type: string
operIP:
type: string
operId:
type: string
operLocation:
type: string
operName:
type: string
operParam:
type: string
operTime:
type: string
operUrl:
type: string
operatorType:
type: integer
requestMethod:
type: string
status:
type: integer
title:
type: string
trackId:
type: string
type: object
model.SysPost:
properties:
createBy:
type: string
createTime:
type: string
postCode:
type: string
postId:
type: string
postName:
type: string
postSort:
type: integer
remark:
type: string
status:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysRole:
properties:
createBy:
type: string
createTime:
type: string
dataScope:
type: string
delFlag:
type: string
deptCheckStrictly:
type: boolean
menuCheckStrictly:
type: boolean
remark:
type: string
roleId:
type: string
roleKey:
type: string
roleName:
type: string
roleSort:
type: integer
status:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
model.SysUser:
properties:
avatar:
type: string
createBy:
type: string
createTime:
type: string
delFlag:
type: string
deptId:
type: string
email:
type: string
gender:
type: string
loginDate:
type: string
loginIP:
type: string
nickName:
type: string
passWord:
type: string
phoneNumber:
type: string
remark:
type: string
resourceInvoke:
type: string
selectKey:
type: string
solt:
type: integer
status:
type: string
updateBy:
type: string
updateTime:
type: string
userId:
type: string
userName:
type: string
userType:
type: string
type: object
model.Title:
properties:
en_US:
type: string
zh_CN:
type: string
type: object
serializer.Response:
properties:
code:
type: integer
data: { }
error:
type: string
msg:
type: string
type: object
service.UserLoginRequest:
properties:
account:
maxLength: 30
minLength: 5
type: string
checked:
type: boolean
password:
maxLength: 40
minLength: 8
type: string
phone:
type: string
verifyCode:
type: string
required:
- account
- checked
- password
type: object
service.UserRegisterRequest:
properties:
nickName:
maxLength: 30
minLength: 2
type: string
passWord:
maxLength: 40
minLength: 8
type: string
passWordConfirm:
maxLength: 40
minLength: 8
type: string
userName:
maxLength: 30
minLength: 5
type: string
required:
- nickName
- passWord
- passWordConfirm
- userName
type: object
types.Column:
properties:
exp:
description: expressions, which default to = when the value is null, have
=, !=, >, >=, <, <=, like, in
type: string
logic:
description: logical type, defaults to and when the value is null, with &(and),
||(or)
type: string
name:
description: column name
type: string
value:
description: column value
type: object
types.Params:
properties:
columns:
description: not required
items:
$ref: '#/definitions/types.Column'
type: array
limit:
minimum: 10
type: integer
page:
minimum: 0
type: integer
sort:
type: string
type: object
types.Payload:
properties:
ids:
items:
type: string
type: array
type: object
host: 127.0.0.1:3000
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: EGO 系统 API 文档
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: EGO API
version: "1.0"
paths:
/api/v1/sysConfig:
post:
consumes:
- application/json
description: 创建新的系统配置信息
parameters:
- description: 配置信息
in: body
name: config
required: true
schema:
$ref: '#/definitions/model.SysConfig'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建配置
tags:
- 配置管理
/api/v1/sysConfig/{id}:
delete:
consumes:
- application/json
description: 根据ID删除系统配置信息
parameters:
- description: 配置ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除配置
tags:
- 配置管理
get:
consumes:
- application/json
description: 根据ID获取系统配置详细信息
parameters:
- description: 配置ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取配置
tags:
- 配置管理
put:
consumes:
- application/json
description: 根据ID更新系统配置信息
parameters:
- description: 配置ID
in: path
name: id
required: true
type: string
- description: 配置信息
in: body
name: config
required: true
schema:
$ref: '#/definitions/model.SysConfig'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新配置
tags:
- 配置管理
/api/v1/sysConfig/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除配置
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除配置
tags:
- 配置管理
/api/v1/sysConfig/condition:
post:
consumes:
- application/json
description: 根据条件查询系统配置列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询配置
tags:
- 配置管理
/api/v1/sysConfig/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询系统配置
parameters:
- description: 配置ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询配置
tags:
- 配置管理
/api/v1/sysDept:
post:
consumes:
- application/json
description: 创建新的部门信息
parameters:
- description: 部门信息
in: body
name: dept
required: true
schema:
$ref: '#/definitions/model.SysDept'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建部门
tags:
- 部门管理
/api/v1/sysDept/{id}:
delete:
consumes:
- application/json
description: 根据ID删除部门信息
parameters:
- description: 部门ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除部门
tags:
- 部门管理
get:
consumes:
- application/json
description: 根据ID获取部门详细信息
parameters:
- description: 部门ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取部门
tags:
- 部门管理
put:
consumes:
- application/json
description: 根据ID更新部门信息
parameters:
- description: 部门ID
in: path
name: id
required: true
type: string
- description: 部门信息
in: body
name: dept
required: true
schema:
$ref: '#/definitions/model.SysDept'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新部门
tags:
- 部门管理
/api/v1/sysDept/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除部门
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除部门
tags:
- 部门管理
/api/v1/sysDept/condition:
post:
consumes:
- application/json
description: 根据条件查询部门列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询部门
tags:
- 部门管理
/api/v1/sysDept/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询部门
parameters:
- description: 部门ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询部门
tags:
- 部门管理
/api/v1/sysDictData:
post:
consumes:
- application/json
description: 创建新的字典数据信息
parameters:
- description: 字典数据信息
in: body
name: dictData
required: true
schema:
$ref: '#/definitions/model.SysDictData'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建字典数据
tags:
- 字典数据
/api/v1/sysDictData/{id}:
delete:
consumes:
- application/json
description: 根据ID删除字典数据信息
parameters:
- description: 字典数据ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除字典数据
tags:
- 字典数据
get:
consumes:
- application/json
description: 根据ID获取字典数据详细信息
parameters:
- description: 字典数据ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取字典数据
tags:
- 字典数据
put:
consumes:
- application/json
description: 根据ID更新字典数据信息
parameters:
- description: 字典数据ID
in: path
name: id
required: true
type: string
- description: 字典数据信息
in: body
name: dictData
required: true
schema:
$ref: '#/definitions/model.SysDictData'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新字典数据
tags:
- 字典数据
/api/v1/sysDictData/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除字典数据
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除字典数据
tags:
- 字典数据
/api/v1/sysDictData/condition:
post:
consumes:
- application/json
description: 根据条件查询字典数据列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询字典数据
tags:
- 字典数据
/api/v1/sysDictData/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询字典数据
parameters:
- description: 字典数据ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询字典数据
tags:
- 字典数据
/api/v1/sysDictType:
post:
consumes:
- application/json
description: 创建新的字典类型信息
parameters:
- description: 字典类型信息
in: body
name: dictType
required: true
schema:
$ref: '#/definitions/model.SysDictType'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建字典类型
tags:
- 字典类型
/api/v1/sysDictType/{id}:
delete:
consumes:
- application/json
description: 根据ID删除字典类型信息
parameters:
- description: 字典类型ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除字典类型
tags:
- 字典类型
get:
consumes:
- application/json
description: 根据ID获取字典类型详细信息
parameters:
- description: 字典类型ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取字典类型
tags:
- 字典类型
put:
consumes:
- application/json
description: 根据ID更新字典类型信息
parameters:
- description: 字典类型ID
in: path
name: id
required: true
type: string
- description: 字典类型信息
in: body
name: dictType
required: true
schema:
$ref: '#/definitions/model.SysDictType'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新字典类型
tags:
- 字典类型
/api/v1/sysDictType/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除字典类型
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除字典类型
tags:
- 字典类型
/api/v1/sysDictType/condition:
post:
consumes:
- application/json
description: 根据条件查询字典类型列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询字典类型
tags:
- 字典类型
/api/v1/sysDictType/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询字典类型
parameters:
- description: 字典类型ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询字典类型
tags:
- 字典类型
/api/v1/sysFile:
post:
consumes:
- application/json
description: 创建文件记录
parameters:
- description: 文件信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.SysFile'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 创建文件记录
tags:
- 文件管理
/api/v1/sysFile/{id}:
delete:
consumes:
- application/json
description: 根据ID删除文件记录
parameters:
- description: 文件ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 删除文件记录
tags:
- 文件管理
get:
consumes:
- application/json
description: 根据ID获取文件记录
parameters:
- description: 文件ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 获取文件记录
tags:
- 文件管理
put:
consumes:
- application/json
description: 根据ID更新文件记录
parameters:
- description: 文件ID
in: path
name: id
required: true
type: string
- description: 文件信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.SysFile'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 更新文件记录
tags:
- 文件管理
/api/v1/sysFile/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除文件记录
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除文件记录
tags:
- 文件管理
/api/v1/sysFile/condition:
post:
consumes:
- application/json
description: 根据条件查询文件记录列表
parameters:
- description: 查询条件
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 条件查询文件记录
tags:
- 文件管理
/api/v1/sysFile/list:
post:
consumes:
- application/json
description: 根据ID列表获取文件记录列表
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量获取文件记录
tags:
- 文件管理
/api/v1/sysJob:
post:
consumes:
- application/json
description: 创建新的定时任务信息
parameters:
- description: 定时任务信息
in: body
name: job
required: true
schema:
$ref: '#/definitions/model.SysJob'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建定时任务
tags:
- 定时任务
/api/v1/sysJob/{id}:
delete:
consumes:
- application/json
description: 根据ID删除定时任务信息
parameters:
- description: 定时任务ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除定时任务
tags:
- 定时任务
get:
consumes:
- application/json
description: 根据ID获取定时任务详细信息
parameters:
- description: 定时任务ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取定时任务
tags:
- 定时任务
put:
consumes:
- application/json
description: 根据ID更新定时任务信息
parameters:
- description: 定时任务ID
in: path
name: id
required: true
type: string
- description: 定时任务信息
in: body
name: job
required: true
schema:
$ref: '#/definitions/model.SysJob'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新定时任务
tags:
- 定时任务
/api/v1/sysJob/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除任务
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除任务
tags:
- 定时任务
/api/v1/sysJob/condition:
post:
consumes:
- application/json
description: 根据条件查询定时任务列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询定时任务
tags:
- 定时任务
/api/v1/sysJob/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询定时任务
parameters:
- description: 定时任务ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询定时任务
tags:
- 定时任务
/api/v1/sysMenu:
post:
consumes:
- application/json
description: 创建新菜单
parameters:
- description: 菜单信息
in: body
name: menu
required: true
schema:
$ref: '#/definitions/model.SysMenu'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建菜单
tags:
- 菜单管理
/api/v1/sysMenu/{id}:
delete:
consumes:
- application/json
description: 根据ID删除菜单
parameters:
- description: 菜单ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除菜单
tags:
- 菜单管理
get:
consumes:
- application/json
description: 根据ID获取菜单信息
parameters:
- description: 菜单ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取菜单
tags:
- 菜单管理
put:
consumes:
- application/json
description: 根据ID更新菜单信息
parameters:
- description: 菜单ID
in: path
name: id
required: true
type: string
- description: 菜单信息
in: body
name: menu
required: true
schema:
$ref: '#/definitions/model.SysMenu'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新菜单
tags:
- 菜单管理
/api/v1/sysMenu/condition:
post:
consumes:
- application/json
description: 根据条件查询菜单列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询菜单
tags:
- 菜单管理
/api/v1/sysMenu/ids:
delete:
consumes:
- application/json
description: 根据ID列表批量删除菜单
parameters:
- description: 菜单ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量删除菜单
tags:
- 菜单管理
/api/v1/sysMenu/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询菜单
parameters:
- description: 菜单ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询菜单
tags:
- 菜单管理
/api/v1/sysMenu/user:
get:
consumes:
- application/json
description: 获取当前用户的菜单列表
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取用户菜单
tags:
- 菜单管理
/api/v1/sysNotice:
post:
consumes:
- application/json
description: 创建新的通知公告信息
parameters:
- description: 通知公告信息
in: body
name: notice
required: true
schema:
$ref: '#/definitions/model.SysNotice'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建通知公告
tags:
- 通知管理
/api/v1/sysNotice/{id}:
delete:
consumes:
- application/json
description: 根据ID删除通知公告信息
parameters:
- description: 通知公告ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除通知公告
tags:
- 通知管理
get:
consumes:
- application/json
description: 根据ID获取通知公告详细信息
parameters:
- description: 通知公告ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取通知公告
tags:
- 通知管理
put:
consumes:
- application/json
description: 根据ID更新通知公告信息
parameters:
- description: 通知公告ID
in: path
name: id
required: true
type: string
- description: 通知公告信息
in: body
name: notice
required: true
schema:
$ref: '#/definitions/model.SysNotice'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新通知公告
tags:
- 通知管理
/api/v1/sysNotice/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除通知
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除通知
tags:
- 通知管理
/api/v1/sysNotice/condition:
post:
consumes:
- application/json
description: 根据条件查询通知公告列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询通知公告
tags:
- 通知管理
/api/v1/sysNotice/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询通知公告
parameters:
- description: 通知公告ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询通知公告
tags:
- 通知管理
/api/v1/sysOperLog:
post:
consumes:
- application/json
description: 创建新的操作日志信息
parameters:
- description: 操作日志信息
in: body
name: operLog
required: true
schema:
$ref: '#/definitions/model.SysOperLog'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建操作日志
tags:
- 操作日志
/api/v1/sysOperLog/{id}:
delete:
consumes:
- application/json
description: 根据ID删除操作日志信息
parameters:
- description: 操作日志ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除操作日志
tags:
- 操作日志
get:
consumes:
- application/json
description: 根据ID获取操作日志详细信息
parameters:
- description: 操作日志ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取操作日志
tags:
- 操作日志
put:
consumes:
- application/json
description: 根据ID更新操作日志信息
parameters:
- description: 操作日志ID
in: path
name: id
required: true
type: string
- description: 操作日志信息
in: body
name: operLog
required: true
schema:
$ref: '#/definitions/model.SysOperLog'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新操作日志
tags:
- 操作日志
/api/v1/sysOperLog/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除操作日志
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除操作日志
tags:
- 操作日志
/api/v1/sysOperLog/condition:
post:
consumes:
- application/json
description: 根据条件查询操作日志列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询操作日志
tags:
- 操作日志
/api/v1/sysOperLog/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询操作日志
parameters:
- description: 操作日志ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询操作日志
tags:
- 操作日志
/api/v1/sysPost:
post:
consumes:
- application/json
description: 创建岗位
parameters:
- description: 岗位信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.SysPost'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 创建岗位
tags:
- 岗位管理
/api/v1/sysPost/{id}:
delete:
consumes:
- application/json
description: 根据ID删除岗位
parameters:
- description: 岗位ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 删除岗位
tags:
- 岗位管理
get:
consumes:
- application/json
description: 根据ID获取岗位信息
parameters:
- description: 岗位ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 获取岗位信息
tags:
- 岗位管理
put:
consumes:
- application/json
description: 根据ID更新岗位信息
parameters:
- description: 岗位ID
in: path
name: id
required: true
type: string
- description: 岗位信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.SysPost'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 更新岗位
tags:
- 岗位管理
/api/v1/sysPost/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除岗位
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除岗位
tags:
- 岗位管理
/api/v1/sysPost/condition:
post:
consumes:
- application/json
description: 根据条件查询岗位列表
parameters:
- description: 查询条件
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 条件查询岗位
tags:
- 岗位管理
/api/v1/sysPost/list:
post:
consumes:
- application/json
description: 根据ID列表获取岗位列表
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量获取岗位
tags:
- 岗位管理
/api/v1/sysRole:
post:
consumes:
- application/json
description: 创建新角色
parameters:
- description: 角色信息
in: body
name: role
required: true
schema:
$ref: '#/definitions/model.SysRole'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建角色
tags:
- 角色管理
/api/v1/sysRole/{id}:
delete:
consumes:
- application/json
description: 根据ID删除角色
parameters:
- description: 角色ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除角色
tags:
- 角色管理
get:
consumes:
- application/json
description: 根据ID获取角色信息
parameters:
- description: 角色ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取角色
tags:
- 角色管理
put:
consumes:
- application/json
description: 根据ID更新角色信息
parameters:
- description: 角色ID
in: path
name: id
required: true
type: string
- description: 角色信息
in: body
name: role
required: true
schema:
$ref: '#/definitions/model.SysRole'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新角色
tags:
- 角色管理
/api/v1/sysRole/{id}/menus:
get:
consumes:
- application/json
description: 获取指定角色的菜单列表
parameters:
- description: 角色ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取角色菜单
tags:
- 角色管理
post:
consumes:
- application/json
description: 为角色分配菜单权限
parameters:
- description: 角色ID
in: path
name: id
required: true
type: string
- description: 菜单ID列表
in: body
name: menuIds
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 分配菜单权限
tags:
- 角色管理
/api/v1/sysRole/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除角色
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除角色
tags:
- 角色管理
/api/v1/sysRole/condition:
post:
consumes:
- application/json
description: 根据条件查询角色列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询角色
tags:
- 角色管理
/api/v1/sysRole/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询角色
parameters:
- description: 角色ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询角色
tags:
- 角色管理
/api/v1/sysRole/user:
get:
consumes:
- application/json
description: 获取指定用户的角色列表
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取用户角色
tags:
- 角色管理
/api/v1/sysUser:
post:
consumes:
- application/json
description: 创建新用户
parameters:
- description: 用户信息
in: body
name: user
required: true
schema:
$ref: '#/definitions/model.SysUser'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 创建用户
tags:
- 用户管理
/api/v1/sysUser/{id}:
delete:
consumes:
- application/json
description: 根据ID删除用户
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 删除用户
tags:
- 用户管理
get:
consumes:
- application/json
description: 根据ID获取用户信息
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取用户
tags:
- 用户管理
put:
consumes:
- application/json
description: 根据ID更新用户信息
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
- description: 用户信息
in: body
name: user
required: true
schema:
$ref: '#/definitions/model.SysUser'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 更新用户
tags:
- 用户管理
/api/v1/sysUser/batch:
delete:
consumes:
- application/json
description: 根据ID列表批量删除用户
parameters:
- description: ID列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/types.Payload'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- ApiKeyAuth: [ ]
summary: 批量删除用户
tags:
- 用户管理
/api/v1/sysUser/condition:
post:
consumes:
- application/json
description: 根据条件查询用户列表
parameters:
- description: 查询条件
in: body
name: query
required: true
schema:
$ref: '#/definitions/types.Params'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 条件查询用户
tags:
- 用户管理
/api/v1/sysUser/list/ids:
post:
consumes:
- application/json
description: 根据ID列表批量查询用户
parameters:
- description: 用户ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 批量查询用户
tags:
- 用户管理
/api/v1/sysUser/logout:
post:
consumes:
- application/json
description: 用户退出登录
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 用户登出
tags:
- 用户管理
/api/v1/sysUser/me:
get:
consumes:
- application/json
description: 获取当前登录用户的详细信息
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
security:
- BearerAuth: [ ]
summary: 获取当前用户信息
tags:
- 用户管理
/api/v1/user/login:
post:
consumes:
- application/json
description: 用户登录接口
parameters:
- description: 用户登录信息
in: body
name: user
required: true
schema:
$ref: '#/definitions/service.UserLoginRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
summary: 用户登录
tags:
- 用户管理
/api/v1/user/register:
post:
consumes:
- application/json
description: 新用户注册接口
parameters:
- description: 用户注册信息
in: body
name: user
required: true
schema:
$ref: '#/definitions/service.UserRegisterRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/serializer.Response'
summary: 用户注册
tags:
- 用户管理
/ping:
get:
description: Get a message from the server
produces:
- application/json
responses:
"200":
description: OK
schema:
additionalProperties:
type: string
type: object
summary: Get a message
securityDefinitions:
BearerAuth:
in: header
name: Authorization
type: apiKey
swagger: "2.0"