basePath: /quin definitions: schemas.CreateRole: properties: description: type: string id: type: integer name: type: string required: - name type: object schemas.CreateUser: properties: avatar: description: Avatar 头像URL type: string email: description: Email 邮箱地址,用于联系和找回密码 type: string id: description: ID 用户ID,数据库自动生成, 不传 type: integer last_login_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: LastLoginTime 最后登录时间,系统生成 nickname: description: Nickname 用户昵称,显示名称 type: string password: description: Password 密码,将被加密存储 type: string register_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: RegisterTime 注册时间,系统生成 rolecode: description: RoleCode 角色编码, 不传, 默认0 type: integer rolename: description: RoleName 角色名称, 不传 type: string sessioncode: description: SessionCode 用户编码 系统生成 type: string status: description: Status 用户状态,不传 type: integer username: description: Username 用户名,系统唯一标识,系统生成, 不传 type: string required: - email - nickname - password type: object schemas.CronJob: properties: create_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: 创建时间 description: description: 任务描述 type: string enabled: description: 任务是否启用 type: integer handler: description: 任务处理程序 type: string id: description: 任务ID type: integer name: description: 任务名称 type: string schedule: description: 任务计划 type: string update_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: 更新时间 type: object schemas.CronJobLog: properties: end_time: $ref: '#/definitions/schemas.CustomTime' handler: type: string id: type: integer job_id: type: integer message: type: string name: type: string schedule: type: string start_time: $ref: '#/definitions/schemas.CustomTime' status: type: string type: object schemas.CronJobLogListRequest: properties: end_date: $ref: '#/definitions/schemas.CustomTime' id: type: integer page_index: type: integer page_size: type: integer start_date: $ref: '#/definitions/schemas.CustomTime' required: - id - page_index - page_size type: object schemas.CronJobUpdateRequest: properties: description: description: |- 任务是否启用 Enabled int `json:"enabled" db:"enabled"` 任务描述 type: string handler: description: 任务处理程序 type: string id: description: 任务ID 传参代表修改 不传参代表新增 type: integer name: description: 任务名称 type: string schedule: description: 任务计划 type: string type: object schemas.CronListRequest: properties: end_date: $ref: '#/definitions/schemas.CustomTime' name: type: string page_index: type: integer page_size: type: integer start_date: $ref: '#/definitions/schemas.CustomTime' required: - page_index - page_size type: object schemas.CronListResponse: properties: items: items: $ref: '#/definitions/schemas.CronJob' type: array page_index: type: integer page_size: type: integer total: type: integer type: object schemas.CustomTime: properties: time: type: string type: object schemas.LoginLog: properties: create_time: $ref: '#/definitions/schemas.CustomTime' failure_reason: type: string id: type: integer ip_address: type: string isdel: type: integer location: type: string login_time: $ref: '#/definitions/schemas.CustomTime' status: type: integer update_time: $ref: '#/definitions/schemas.CustomTime' user_agent: type: string user_id: type: integer username: type: string type: object schemas.LoginLogListRequest: properties: end_date: $ref: '#/definitions/schemas.CustomTime' page_index: type: integer page_size: type: integer start_date: $ref: '#/definitions/schemas.CustomTime' required: - page_index - page_size type: object schemas.LoginRequest: properties: password: description: Password 密码,用于登录验证 type: string username: description: Username 用户名,用于登录验证 type: string required: - password - username type: object schemas.MenuItems: properties: component: description: 组件名称 type: string create_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: 创建时间 icon: description: 菜单项图标 type: string id: description: ID 菜单项ID type: integer parent_id: description: 父级菜单项ID type: integer path: description: 菜单项路径 type: string sort: description: 排序 type: integer status: description: 状态 type: integer title: description: 菜单项标题 type: string visible: description: 是否可见 type: integer type: object schemas.MenuListRequest: properties: page_index: type: integer page_size: type: integer required: - page_index - page_size type: object schemas.PermissionItems: properties: action: type: string children: items: $ref: '#/definitions/schemas.PermissionItems' type: array id: type: integer module: type: string name: type: string parent_id: type: integer path: type: string sort: type: integer status: type: integer title: type: string type: type: string type: object schemas.RoleListRequest: properties: end_date: $ref: '#/definitions/schemas.CustomTime' page_index: type: integer page_size: type: integer start_date: $ref: '#/definitions/schemas.CustomTime' required: - page_index - page_size type: object schemas.RoleResponseList: properties: code: description: Code 角色编码 type: string create_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: CreateTime 创建时间 description: description: Desc 角色描述 type: string id: description: ID 角色ID type: integer name: description: Name 角色名称 type: string status: description: Status 角色状态 type: integer type: object schemas.UpdateUser: properties: avatar: description: Avatar 头像URL type: string email: description: Email 邮箱地址,用于联系和找回密码 type: string id: description: ID 用户编码,用于定位用户 type: integer nickname: description: Nickname 用户昵称,显示名称 type: string password: description: Password 密码,将被加密存储 type: string required: - id type: object schemas.UserInfo: properties: avatar: description: 头像URL type: string email: description: 邮箱地址 type: string id: description: 用户ID type: integer last_login_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: 最后登录时间 nickname: description: 昵称 type: string password: description: 密码 type: string register_time: allOf: - $ref: '#/definitions/schemas.CustomTime' description: 注册时间 rolecode: description: 角色编码 type: integer rolename: description: 角色名称 type: string sessioncode: description: 用户编码 type: string status: description: 用户状态 type: integer username: description: 用户名 type: string required: - email - nickname - password type: object schemas.UserListRequest: properties: end_time: $ref: '#/definitions/schemas.CustomTime' nickname: description: 昵称(用户名) type: string page_index: type: integer page_size: type: integer start_time: $ref: '#/definitions/schemas.CustomTime' required: - page_index - page_size type: object schemas.UserListResponse: properties: items: items: $ref: '#/definitions/schemas.UserInfo' type: array page_index: type: integer page_size: type: integer total: type: integer type: object schemas.UserResponse: properties: authorization: type: string type: object utils.Response: properties: data: {} message: type: string status: type: integer type: object host: localhost:8080 info: contact: email: support@swagger.io name: API Support url: http://www.swagger.io/support description: 打造一款综合性接口平台. license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html termsOfService: http://swagger.io/terms/ title: Quincy_admin version: "1.0" paths: /cron/{id}: delete: consumes: - application/json description: 删除定时任务 parameters: - description: id(任务ID) in: path name: id required: true type: string produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 删除定时任务 tags: - 任务管理 put: consumes: - application/json description: 启用/停用任务 parameters: - description: id in: path name: id required: true type: string - description: 启用状态(1:启用,0:停用) in: query name: enabled type: integer produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 启用/停用任务 tags: - 任务管理 /cron/hand: post: consumes: - application/json description: 新增/更新任务 parameters: - description: 新增/更新任务 in: body name: req required: true schema: $ref: '#/definitions/schemas.CronJobUpdateRequest' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 新增/更新任务 tags: - 任务管理 /cron/list: post: consumes: - application/json description: 定时任务列表 parameters: - description: 定时任务 in: body name: req required: true schema: $ref: '#/definitions/schemas.CronListRequest' produces: - application/json responses: "200": description: 定时任务 schema: $ref: '#/definitions/schemas.CronListResponse' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 定时任务列表 tags: - 任务管理 /cron/loglist: post: consumes: - application/json description: 查看日志运行记录 parameters: - description: req in: body name: req required: true schema: $ref: '#/definitions/schemas.CronJobLogListRequest' produces: - application/json responses: "200": description: res schema: $ref: '#/definitions/schemas.CronJobLog' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 查看日志运行记录 tags: - 任务管理 /cron/restart: get: consumes: - application/json description: 重启定时任务 produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 重启定时任务 tags: - 任务管理 /cron/stop: get: consumes: - application/json description: 停止所有任务 produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 停止所有任务 tags: - 任务管理 /pms/menus: post: consumes: - application/json description: 获取管理后台菜单列表 parameters: - description: req in: body name: role required: true schema: $ref: '#/definitions/schemas.MenuListRequest' produces: - application/json responses: "200": description: 菜单信息 schema: $ref: '#/definitions/schemas.MenuItems' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 获取菜单列表 tags: - 权限模块 /pms/menus/{id}: put: consumes: - application/json description: 启用停用菜单 parameters: - description: id in: path name: id required: true type: string - description: 启用状态(1:启用,0:停用) in: query name: status type: integer produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 启用停用菜单 tags: - 权限模块 /pms/permission: get: consumes: - application/json description: 根据用户Session和权限type获取权限列表 parameters: - description: all-全部 button-按钮,route-路由,menu-菜单,api-接口 in: query name: type type: string produces: - application/json responses: "200": description: 权限列表 schema: items: type: string type: array "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 获取权限列表 tags: - 权限模块 /pms/permission/all: get: consumes: - application/json description: 获取所有权限 produces: - application/json responses: "200": description: 权限列表 schema: $ref: '#/definitions/schemas.PermissionItems' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] - ApiKeyAuth: [] summary: 获取所有权限 tags: - 权限模块 /pms/permission/assign/{role_id}: put: consumes: - application/json description: 为指定角色分配权限 parameters: - description: 角色ID in: path name: role_id required: true type: integer - collectionFormat: csv description: 权限ID数组 in: query items: type: integer name: permission_ids required: true type: array produces: - application/json responses: "200": description: 权限分配成功 schema: $ref: '#/definitions/utils.Response' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 分配角色权限 tags: - 权限模块 /pms/permission/role: get: consumes: - application/json description: 获取角色权限 parameters: - description: 角色ID in: query name: role_id required: true type: integer - description: all-全部 button-按钮,route-路由,menu-菜单,api-接口 in: query name: type type: string produces: - application/json responses: "200": description: 权限列表 schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: items: type: integer type: array type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 获取角色权限 tags: - 权限模块 /pms/routes: get: consumes: - application/json description: 根据用户Session获取侧边栏菜单权限 produces: - application/json responses: "200": description: 菜单信息 schema: $ref: '#/definitions/schemas.MenuItems' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 侧边菜单权限 tags: - 权限模块 /system/log/download: get: description: 下载指定的日志文件内容 parameters: - description: 日志文件名 in: query name: filename required: true type: string produces: - application/octet-stream responses: "200": description: 日志文件内容 schema: type: file "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 下载日志文件 tags: - 系统管理 /system/log/login/list: post: description: 系统登录日志 parameters: - description: req in: body name: role required: true schema: $ref: '#/definitions/schemas.LoginLogListRequest' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: $ref: '#/definitions/schemas.LoginLog' type: object "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 系统登录日志 tags: - 系统管理 /system/log/view: get: description: 返回指定日志文件的内容 parameters: - description: 日志文件名 in: query name: filename required: true type: string - description: 返回行数,默认100行 in: query name: lines type: integer produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 查看日志文件内容 tags: - 系统管理 /user/{id}: put: description: 禁用/启用用户 parameters: - description: 用户ID in: path name: id required: true type: string - description: 启用状态(1:启用,0:停用) in: query name: status type: integer responses: "200": description: OK schema: $ref: '#/definitions/utils.Response' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 禁用/启用用户 tags: - 用户管理 /user/assign: put: description: 用户角色分配 parameters: - description: 用户ID in: query name: user_id required: true type: string - description: 角色ID in: query name: role_id type: integer responses: "200": description: OK schema: $ref: '#/definitions/utils.Response' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 用户角色分配 tags: - 用户管理 /user/getinfo: get: description: 获取用户信息 produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: $ref: '#/definitions/schemas.UserInfo' type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "404": description: Not Found schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 获取用户信息 tags: - 用户管理 /user/list: post: description: 获取用户列表 parameters: - description: 请求体 in: body name: user required: true schema: $ref: '#/definitions/schemas.UserListRequest' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: $ref: '#/definitions/schemas.UserListResponse' type: object "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 获取用户列表 tags: - 用户管理 /user/login: post: consumes: - application/json description: 用户登录验证 parameters: - description: req in: body name: login required: true schema: $ref: '#/definitions/schemas.LoginRequest' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: $ref: '#/definitions/schemas.UserResponse' type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "401": description: Unauthorized schema: $ref: '#/definitions/utils.Response' "403": description: Forbidden schema: $ref: '#/definitions/utils.Response' summary: 用户登录 tags: - 用户管理 /user/register: post: consumes: - application/json description: 创建用户 parameters: - description: 用户信息 in: body name: user required: true schema: $ref: '#/definitions/schemas.CreateUser' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: $ref: '#/definitions/schemas.UserResponse' type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 创建用户 tags: - 用户管理 /user/role: post: description: 创建角色 parameters: - description: req in: body name: role required: true schema: $ref: '#/definitions/schemas.CreateRole' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/utils.Response' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 创建角色 tags: - 用户管理 /user/role/{id}: put: description: 禁用/启用角色 parameters: - description: 角色ID in: path name: id required: true type: string - description: 启用状态(1:启用,0:停用) in: query name: status type: integer responses: "200": description: OK schema: $ref: '#/definitions/utils.Response' "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 禁用/启用角色 tags: - 用户管理 /user/rolelist: post: description: 获取角色列表 parameters: - description: req in: body name: role required: true schema: $ref: '#/definitions/schemas.RoleListRequest' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: $ref: '#/definitions/schemas.RoleResponseList' type: object "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 获取角色列表 tags: - 用户管理 /user/update: put: consumes: - application/json description: 更新用户信息 parameters: - description: 用户信息 in: body name: user required: true schema: $ref: '#/definitions/schemas.UpdateUser' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/utils.Response' - properties: data: type: string type: object "400": description: Bad Request schema: $ref: '#/definitions/utils.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/utils.Response' security: - ApiKeyAuth: [] summary: 更新用户信息 tags: - 用户管理 securityDefinitions: ApiKeyAuth: in: header name: Authorization type: apiKey swagger: "2.0"