Files
x_admin/server/docs/swagger.yaml
xiangheng fe33721abf 注释
2024-11-08 17:43:07 +08:00

2814 lines
67 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.

basePath: /
definitions:
core.NullFloat:
properties:
float:
type: number
valid:
type: boolean
type: object
core.NullInt:
properties:
int:
type: integer
valid:
type: boolean
type: object
core.NullTime:
properties:
format:
type: string
time:
type: string
valid:
type: boolean
type: object
flow_apply.FlowApplyResp:
properties:
applyUserId:
description: 申请人id
type: integer
applyUserNickname:
description: 申请人昵称
type: string
createTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 创建时间
flowFormData:
description: 表单配置
type: string
flowGroup:
description: 流程分类
type: integer
flowName:
description: 流程名称
type: string
flowProcessData:
description: 流程配置
type: string
flowProcessDataList:
description: 流程配置list数据
type: string
flowRemark:
description: 流程描述
type: string
formValue:
description: 表单值
type: string
id:
type: integer
status:
description: 状态1待提交2审批中3审批完成4审批失败
type: integer
templateId:
description: 模板
type: integer
updateTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 更新时间
type: object
flow_history.FlowHistoryResp:
properties:
applyId:
description: 申请id
type: integer
applyUserId:
description: 申请人id
type: integer
applyUserNickname:
description: 申请人昵称
type: string
approverId:
description: 审批人id
type: integer
approverNickname:
description: 审批用户昵称
type: string
createTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 创建时间
formValue:
description: 表单值
type: string
id:
description: 历史id
type: integer
nodeId:
description: 节点
type: string
nodeLabel:
description: 节点名称
type: string
nodeType:
description: 节点类型
type: string
passRemark:
description: 通过备注
type: string
passStatus:
description: 通过状态1待处理2通过3拒绝
type: integer
templateId:
description: 模板id
type: integer
updateTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 更新时间
type: object
flow_template.FlowTemplateResp:
properties:
flowFormData:
description: 表单配置
type: string
flowGroup:
description: 流程分类
type: integer
flowName:
description: 流程名称
type: string
flowProcessData:
description: 流程配置
type: string
flowProcessDataList:
description: 流程配置list数据
type: string
flowRemark:
description: 流程描述
type: string
id:
type: integer
type: object
monitor_client.MonitorClientResp:
properties:
browser:
description: 浏览器
type: string
city:
description: 城市
type: string
clientId:
description: sdk生成的客户端id
type: string
country:
description: 国家
type: string
createTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 创建时间
height:
allOf:
- $ref: '#/definitions/core.NullInt'
description: 屏幕高度
id:
description: uuid
type: integer
ip:
description: ip
type: string
operator:
description: 电信运营商
type: string
os:
description: 系统
type: string
projectKey:
description: 项目key
type: string
province:
description: 省份
type: string
ua:
description: ua记录
type: string
userId:
description: 用户id
type: string
width:
allOf:
- $ref: '#/definitions/core.NullInt'
description: 屏幕
type: object
monitor_error.MonitorErrorResp:
properties:
createTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 创建时间
eventType:
description: 事件类型
type: string
id:
description: 错误id
type: integer
md5:
description: md5
type: string
message:
description: 错误消息
type: string
path:
description: URL地址
type: string
projectKey:
description: 项目key
type: string
stack:
description: 错误堆栈
type: string
type: object
monitor_project.MonitorProjectResp:
properties:
createTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 创建时间
id:
description: 项目id
type: integer
projectKey:
description: 项目uuid
type: string
projectName:
description: 项目名称
type: string
projectType:
description: 项目类型go java web node php 等
type: string
status:
allOf:
- $ref: '#/definitions/core.NullInt'
description: '是否启用: 0=否, 1=是'
updateTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 更新时间
type: object
monitor_slow.MonitorSlowResp:
properties:
clientId:
description: sdk生成的客户端id
type: string
createTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 创建时间
id:
description: 错误id
type: integer
path:
description: URL地址
type: string
projectKey:
description: 项目key
type: string
time:
allOf:
- $ref: '#/definitions/core.NullFloat'
description: 时间
userId:
description: 用户id
type: string
type: object
response.PageResp:
properties:
count:
description: 总数
type: integer
lists:
description: 数据
pageNo:
description: 每页数量
type: integer
pageSize:
description: 每页Size
type: integer
type: object
response.Response:
properties:
code:
type: integer
data: {}
message:
type: string
type: object
user_protocol.UserProtocolResp:
properties:
content:
description: 协议内容
type: string
createTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 创建时间
id:
type: integer
sort:
allOf:
- $ref: '#/definitions/core.NullFloat'
description: 排序
title:
description: 标题
type: string
updateTime:
allOf:
- $ref: '#/definitions/core.NullTime'
description: 更新时间
type: object
externalDocs:
description: OpenAPI
url: https://swagger.io/resources/open-api/
host: localhost:8001
info:
contact:
email: 11675084@qq.com
name: API Support
url: http://x.adtk.cn
description: x_admin是一个完整的后台管理系统
license:
name: MIT License
url: https://gitee.com/xiangheng/x_admin/blob/main/LICENSE
termsOfService: http://x.adtk.cn
title: x_admin文档
version: 0.0.1
paths:
/api/admin/flow/flow_apply/add:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 模板
in: body
name: templateId
schema:
type: integer
- description: 申请人id
in: body
name: applyUserId
schema:
type: integer
- description: 申请人昵称
in: body
name: applyUserNickname
schema:
type: string
- description: 流程名称
in: body
name: flowName
schema:
type: string
- description: 流程分类
in: body
name: flowGroup
schema:
type: integer
- description: 流程描述
in: body
name: flowRemark
schema:
type: string
- description: 表单配置
in: body
name: flowFormData
schema:
type: string
- description: 流程配置
in: body
name: flowProcessData
schema:
type: string
- description: 状态1待提交2审批中3审批完成4审批失败
in: body
name: status
schema:
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 申请流程新增
tags:
- flow_apply-申请流程
/api/admin/flow/flow_apply/back:
post:
responses: {}
tags:
- flow_history-流程历史
/api/admin/flow/flow_apply/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 申请id
in: body
name: id
schema:
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 申请流程删除
tags:
- flow_apply-申请流程
/api/admin/flow/flow_apply/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 申请id
in: query
name: id
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/flow_apply.FlowApplyResp'
type: object
summary: 申请流程详情
tags:
- flow_apply-申请流程
/api/admin/flow/flow_apply/edit:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 申请id
in: body
name: id
schema:
type: integer
- description: 模板
in: body
name: templateId
schema:
type: integer
- description: 申请人id
in: body
name: applyUserId
schema:
type: integer
- description: 申请人昵称
in: body
name: applyUserNickname
schema:
type: string
- description: 流程名称
in: body
name: flowName
schema:
type: string
- description: 流程分类
in: body
name: flowGroup
schema:
type: integer
- description: 流程描述
in: body
name: flowRemark
schema:
type: string
- description: 表单配置
in: body
name: flowFormData
schema:
type: string
- description: 流程配置
in: body
name: flowProcessData
schema:
type: string
- description: 状态1待提交2审批中3审批完成4审批失败
in: body
name: status
schema:
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 申请流程编辑
tags:
- flow_apply-申请流程
/api/admin/flow/flow_apply/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 模板
in: query
name: templateId
type: integer
- description: 申请人id
in: query
name: applyUserId
type: integer
- description: 申请人昵称
in: query
name: applyUserNickname
type: string
- description: 流程名称
in: query
name: flowName
type: string
- description: 流程分类
in: query
name: flowGroup
type: integer
- description: 流程描述
in: query
name: flowRemark
type: string
- description: 表单配置
in: query
name: flowFormData
type: string
- description: 流程配置
in: query
name: flowProcessData
type: string
- description: 状态1待提交2审批中3审批完成4审批失败
in: query
name: status
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
lists:
items:
$ref: '#/definitions/flow_apply.FlowApplyResp'
type: array
type: object
type: object
summary: 申请流程列表
tags:
- flow_apply-申请流程
/api/admin/flow/flow_apply/pass:
post:
responses: {}
tags:
- flow_history-流程历史
/api/admin/flow/flow_history/add:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 申请id
in: body
name: applyId
schema:
type: integer
- description: 模板id
in: body
name: templateId
schema:
type: integer
- description: 申请人id
in: body
name: applyUserId
schema:
type: integer
- description: 申请人昵称
in: body
name: applyUserNickname
schema:
type: string
- description: 审批人id
in: body
name: approverId
schema:
type: integer
- description: 审批用户昵称
in: body
name: approverNickname
schema:
type: string
- description: 节点
in: body
name: nodeId
schema:
type: string
- description: 表单值
in: body
name: formValue
schema:
type: string
- description: 通过状态0待处理1通过2拒绝
in: body
name: passStatus
schema:
type: integer
- description: 通过备注
in: body
name: passRemark
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 流程历史新增
tags:
- flow_history-流程历史
/api/admin/flow/flow_history/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 历史id
in: body
name: id
schema:
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 流程历史删除
tags:
- flow_history-流程历史
/api/admin/flow/flow_history/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 历史id
in: query
name: id
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/flow_history.FlowHistoryResp'
type: object
summary: 流程历史详情
tags:
- flow_history-流程历史
/api/admin/flow/flow_history/edit:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 历史id
in: body
name: id
schema:
type: integer
- description: 申请id
in: body
name: applyId
schema:
type: integer
- description: 模板id
in: body
name: templateId
schema:
type: integer
- description: 申请人id
in: body
name: applyUserId
schema:
type: integer
- description: 申请人昵称
in: body
name: applyUserNickname
schema:
type: string
- description: 审批人id
in: body
name: approverId
schema:
type: integer
- description: 审批用户昵称
in: body
name: approverNickname
schema:
type: string
- description: 节点
in: body
name: nodeId
schema:
type: string
- description: 表单值
in: body
name: formValue
schema:
type: string
- description: 通过状态0待处理1通过2拒绝
in: body
name: passStatus
schema:
type: integer
- description: 通过备注
in: body
name: passRemark
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 流程历史编辑
tags:
- flow_history-流程历史
/api/admin/flow/flow_history/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 申请id
in: query
name: applyId
type: integer
- description: 模板id
in: query
name: templateId
type: integer
- description: 申请人id
in: query
name: applyUserId
type: integer
- description: 申请人昵称
in: query
name: applyUserNickname
type: string
- description: 审批人id
in: query
name: approverId
type: integer
- description: 审批用户昵称
in: query
name: approverNickname
type: string
- description: 节点
in: query
name: nodeId
type: string
- description: 表单值
in: query
name: formValue
type: string
- description: 通过状态0待处理1通过2拒绝
in: query
name: passStatus
type: integer
- description: 通过备注
in: query
name: passRemark
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
lists:
items:
$ref: '#/definitions/flow_history.FlowHistoryResp'
type: array
type: object
type: object
summary: 流程历史列表
tags:
- flow_history-流程历史
/api/admin/flow/flow_history/listAll:
get:
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/flow_history.FlowHistoryResp'
type: object
summary: 流程历史列表-所有
tags:
- flow_history-流程历史
/api/admin/flow/flow_template/add:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 流程名称
in: body
name: flowName
schema:
type: string
- description: 流程分类
in: body
name: flowGroup
schema:
type: integer
- description: 流程描述
in: body
name: flowRemark
schema:
type: string
- description: 表单配置
in: body
name: flowFormData
schema:
type: string
- description: 流程配置
in: body
name: flowProcessData
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 流程模板新增
tags:
- flow_template-流程模板
/api/admin/flow/flow_template/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 历史id
in: body
name: id
schema:
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 流程模板删除
tags:
- flow_template-流程模板
/api/admin/flow/flow_template/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 历史id
in: query
name: id
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/flow_template.FlowTemplateResp'
summary: 流程模板详情
tags:
- flow_template-流程模板
/api/admin/flow/flow_template/edit:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: .
in: body
name: id
schema:
type: integer
- description: 流程名称
in: body
name: flowName
schema:
type: string
- description: 流程分类
in: body
name: flowGroup
schema:
type: integer
- description: 流程描述
in: body
name: flowRemark
schema:
type: string
- description: 表单配置
in: body
name: flowFormData
schema:
type: string
- description: 流程配置
in: body
name: flowProcessData
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 流程模板编辑
tags:
- flow_template-流程模板
/api/admin/flow/flow_template/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 流程名称
in: query
name: flowName
type: string
- description: 流程分类
in: query
name: flowGroup
type: integer
- description: 流程描述
in: query
name: flowRemark
type: string
- description: 表单配置
in: query
name: flowFormData
type: string
- description: 流程配置
in: query
name: flowProcessData
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
lists:
items:
$ref: '#/definitions/flow_template.FlowTemplateResp'
type: array
type: object
type: object
summary: 流程模板列表
tags:
- flow_template-流程模板
/api/admin/flow/flow_template/listAll:
get:
responses: {}
summary: 流程模板列表-所有
tags:
- flow_template-流程模板
/api/admin/monitor_client/ExportFile:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目key
in: query
name: ProjectKey
type: string
- description: sdk生成的客户端id
in: query
name: ClientId
type: string
- description: 用户id
in: query
name: UserId
type: string
- description: 系统
in: query
name: Os
type: string
- description: 浏览器
in: query
name: Browser
type: string
- description: 国家
in: query
name: Country
type: string
- description: 省份
in: query
name: Province
type: string
- description: 城市
in: query
name: City
type: string
- description: 电信运营商
in: query
name: Operator
type: string
- description: ip
in: query
name: Ip
type: string
- description: 屏幕
in: query
name: Width
type: number
- description: 屏幕高度
in: query
name: Height
type: number
- description: ua记录
in: query
name: Ua
type: string
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses: {}
summary: 监控-客户端信息导出
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_client/ImportFile:
post:
produces:
- application/json
responses: {}
summary: 监控-客户端信息导入
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_client/add:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目key
in: body
name: ProjectKey
schema:
type: string
- description: sdk生成的客户端id
in: body
name: ClientId
schema:
type: string
- description: 用户id
in: body
name: UserId
schema:
type: string
- description: 系统
in: body
name: Os
schema:
type: string
- description: 浏览器
in: body
name: Browser
schema:
type: string
- description: 国家
in: query
name: Country
type: string
- description: 省份
in: query
name: Province
type: string
- description: 城市
in: query
name: City
type: string
- description: 电信运营商
in: query
name: Operator
type: string
- description: ip
in: query
name: Ip
type: string
- description: 屏幕
in: body
name: Width
schema:
type: number
- description: 屏幕高度
in: body
name: Height
schema:
type: number
- description: ua记录
in: body
name: Ua
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-客户端信息新增
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_client/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: uuid
in: body
name: Id
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-客户端信息删除
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_client/delBatch:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 逗号分割的id
in: body
name: Ids
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-客户端信息删除-批量
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_client/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: uuid
in: query
name: Id
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
$ref: '#/definitions/monitor_client.MonitorClientResp'
type: object
summary: 监控-客户端信息详情
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_client/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 项目key
in: query
name: ProjectKey
type: string
- description: sdk生成的客户端id
in: query
name: ClientId
type: string
- description: 用户id
in: query
name: UserId
type: string
- description: 系统
in: query
name: Os
type: string
- description: 浏览器
in: query
name: Browser
type: string
- description: 国家
in: query
name: Country
type: string
- description: 省份
in: query
name: Province
type: string
- description: 城市
in: query
name: City
type: string
- description: 电信运营商
in: query
name: Operator
type: string
- description: ip
in: query
name: Ip
type: string
- description: 屏幕
in: query
name: Width
type: number
- description: 屏幕高度
in: query
name: Height
type: number
- description: ua记录
in: query
name: Ua
type: string
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
' lists':
items:
$ref: '#/definitions/monitor_client.MonitorClientResp'
type: array
type: object
type: object
summary: 监控-客户端信息列表
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_client/listAll:
get:
parameters:
- description: 项目key
in: query
name: ProjectKey
type: string
- description: sdk生成的客户端id
in: query
name: ClientId
type: string
- description: 用户id
in: query
name: UserId
type: string
- description: 系统
in: query
name: Os
type: string
- description: 浏览器
in: query
name: Browser
type: string
- description: 国家
in: query
name: Country
type: string
- description: 省份
in: query
name: Province
type: string
- description: 城市
in: query
name: City
type: string
- description: 电信运营商
in: query
name: Operator
type: string
- description: ip
in: query
name: Ip
type: string
- description: 屏幕
in: query
name: Width
type: number
- description: 屏幕高度
in: query
name: Height
type: number
- description: ua记录
in: query
name: Ua
type: string
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
items:
$ref: '#/definitions/monitor_client.MonitorClientResp'
type: array
type: object
summary: 监控-客户端信息列表-所有
tags:
- monitor_client-监控-客户端信息
/api/admin/monitor_error/ExportFile:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目key
in: query
name: ProjectKey
type: string
- description: 事件类型
in: query
name: EventType
type: string
- description: URL地址
in: query
name: Path
type: string
- description: 错误消息
in: query
name: Message
type: string
- description: 错误堆栈
in: query
name: Stack
type: string
- description: md5
in: query
name: Md5
type: string
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses: {}
summary: 监控-错误列导出
tags:
- monitor_error-监控-错误列
/api/admin/monitor_error/ImportFile:
post:
produces:
- application/json
responses: {}
summary: 监控-错误列导入
tags:
- monitor_error-监控-错误列
/api/admin/monitor_error/add:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目key
in: body
name: ProjectKey
schema:
type: string
- description: 事件类型
in: body
name: EventType
schema:
type: string
- description: URL地址
in: body
name: Path
schema:
type: string
- description: 错误消息
in: body
name: Message
schema:
type: string
- description: 错误堆栈
in: body
name: Stack
schema:
type: string
- description: md5
in: body
name: Md5
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-错误列新增
tags:
- monitor_error-监控-错误列
/api/admin/monitor_error/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 错误id
in: body
name: Id
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-错误列删除
tags:
- monitor_error-监控-错误列
/api/admin/monitor_error/delBatch:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 逗号分割的id
in: body
name: Ids
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-错误列删除-批量
tags:
- monitor_error-监控-错误列
/api/admin/monitor_error/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 错误id
in: query
name: Id
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
$ref: '#/definitions/monitor_error.MonitorErrorResp'
type: object
summary: 监控-错误列详情
tags:
- monitor_error-监控-错误列
/api/admin/monitor_error/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 项目key
in: query
name: ProjectKey
type: string
- description: 事件类型
in: query
name: EventType
type: string
- description: URL地址
in: query
name: Path
type: string
- description: 错误消息
in: query
name: Message
type: string
- description: 错误堆栈
in: query
name: Stack
type: string
- description: md5
in: query
name: Md5
type: string
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
' lists':
items:
$ref: '#/definitions/monitor_error.MonitorErrorResp'
type: array
type: object
type: object
summary: 监控-错误列列表
tags:
- monitor_error-监控-错误列
/api/admin/monitor_error/listAll:
get:
parameters:
- description: 项目key
in: query
name: ProjectKey
type: string
- description: 事件类型
in: query
name: EventType
type: string
- description: URL地址
in: query
name: Path
type: string
- description: 错误消息
in: query
name: Message
type: string
- description: 错误堆栈
in: query
name: Stack
type: string
- description: md5
in: query
name: Md5
type: string
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
items:
$ref: '#/definitions/monitor_error.MonitorErrorResp'
type: array
type: object
summary: 监控-错误列列表-所有
tags:
- monitor_error-监控-错误列
/api/admin/monitor_project/ExportFile:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目uuid
in: query
name: ProjectKey
type: string
- description: 项目名称
in: query
name: ProjectName
type: string
- description: 项目类型go java web node php 等
in: query
name: ProjectType
type: string
- description: '是否启用: 0=否, 1=是'
in: query
name: Status
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
- description: 更新时间
in: query
name: UpdateTimeStart
type: string
- description: 更新时间
in: query
name: UpdateTimeEnd
type: string
produces:
- application/json
responses: {}
summary: 监控项目导出
tags:
- monitor_project-监控项目
/api/admin/monitor_project/ImportFile:
post:
produces:
- application/json
responses: {}
summary: 监控项目导入
tags:
- monitor_project-监控项目
/api/admin/monitor_project/add:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目uuid
in: body
name: ProjectKey
schema:
type: string
- description: 项目名称
in: body
name: ProjectName
schema:
type: string
- description: 项目类型go java web node php 等
in: body
name: ProjectType
schema:
type: string
- description: '是否启用: 0=否, 1=是'
in: body
name: Status
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控项目新增
tags:
- monitor_project-监控项目
/api/admin/monitor_project/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目id
in: body
name: Id
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控项目删除
tags:
- monitor_project-监控项目
/api/admin/monitor_project/delBatch:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 逗号分割的id
in: body
name: Ids
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控项目删除-批量
tags:
- monitor_project-监控项目
/api/admin/monitor_project/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目id
in: query
name: Id
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
$ref: '#/definitions/monitor_project.MonitorProjectResp'
type: object
summary: 监控项目详情
tags:
- monitor_project-监控项目
/api/admin/monitor_project/edit:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目id
in: body
name: Id
schema:
type: number
- description: 项目uuid
in: body
name: ProjectKey
schema:
type: string
- description: 项目名称
in: body
name: ProjectName
schema:
type: string
- description: 项目类型go java web node php 等
in: body
name: ProjectType
schema:
type: string
- description: '是否启用: 0=否, 1=是'
in: body
name: Status
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控项目编辑
tags:
- monitor_project-监控项目
/api/admin/monitor_project/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 项目uuid
in: query
name: ProjectKey
type: string
- description: 项目名称
in: query
name: ProjectName
type: string
- description: 项目类型go java web node php 等
in: query
name: ProjectType
type: string
- description: '是否启用: 0=否, 1=是'
in: query
name: Status
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
- description: 更新时间
in: query
name: UpdateTimeStart
type: string
- description: 更新时间
in: query
name: UpdateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
' lists':
items:
$ref: '#/definitions/monitor_project.MonitorProjectResp'
type: array
type: object
type: object
summary: 监控项目列表
tags:
- monitor_project-监控项目
/api/admin/monitor_project/listAll:
get:
parameters:
- description: 项目uuid
in: query
name: ProjectKey
type: string
- description: 项目名称
in: query
name: ProjectName
type: string
- description: 项目类型go java web node php 等
in: query
name: ProjectType
type: string
- description: '是否启用: 0=否, 1=是'
in: query
name: Status
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
- description: 更新时间
in: query
name: UpdateTimeStart
type: string
- description: 更新时间
in: query
name: UpdateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
items:
$ref: '#/definitions/monitor_project.MonitorProjectResp'
type: array
type: object
summary: 监控项目列表-所有
tags:
- monitor_project-监控项目
/api/admin/monitor_slow/ExportFile:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 项目key
in: query
name: ProjectKey
type: string
- description: sdk生成的客户端id
in: query
name: ClientId
type: string
- description: 用户id
in: query
name: UserId
type: string
- description: URL地址
in: query
name: Path
type: string
- description: 时间
in: query
name: Time
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses: {}
summary: 监控-错误列导出
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/ImportFile:
post:
produces:
- application/json
responses: {}
summary: 监控-错误列导入
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/add:
get:
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-错误列新增
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 错误id
in: body
name: Id
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-错误列删除
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/delBatch:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 逗号分割的id
in: body
name: Ids
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-错误列删除-批量
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 错误id
in: query
name: Id
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
$ref: '#/definitions/monitor_slow.MonitorSlowResp'
type: object
summary: 监控-错误列详情
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/edit:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 错误id
in: body
name: Id
schema:
type: number
- description: 项目key
in: body
name: ProjectKey
schema:
type: string
- description: sdk生成的客户端id
in: body
name: ClientId
schema:
type: string
- description: 用户id
in: body
name: UserId
schema:
type: string
- description: URL地址
in: body
name: Path
schema:
type: string
- description: 时间
in: body
name: Time
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 监控-错误列编辑
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 项目key
in: query
name: ProjectKey
type: string
- description: sdk生成的客户端id
in: query
name: ClientId
type: string
- description: 用户id
in: query
name: UserId
type: string
- description: URL地址
in: query
name: Path
type: string
- description: 时间
in: query
name: Time
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
' lists':
items:
$ref: '#/definitions/monitor_slow.MonitorSlowResp'
type: array
type: object
type: object
summary: 监控-错误列列表
tags:
- monitor_slow-监控-错误列
/api/admin/monitor_slow/listAll:
get:
parameters:
- description: 项目key
in: query
name: ProjectKey
type: string
- description: sdk生成的客户端id
in: query
name: ClientId
type: string
- description: 用户id
in: query
name: UserId
type: string
- description: URL地址
in: query
name: Path
type: string
- description: 时间
in: query
name: Time
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
items:
$ref: '#/definitions/monitor_slow.MonitorSlowResp'
type: array
type: object
summary: 监控-错误列列表-所有
tags:
- monitor_slow-监控-错误列
/api/admin/user_protocol/ExportFile:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 标题
in: query
name: Title
type: string
- description: 协议内容
in: query
name: Content
type: string
- description: 排序
in: query
name: Sort
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
- description: 更新时间
in: query
name: UpdateTimeStart
type: string
- description: 更新时间
in: query
name: UpdateTimeEnd
type: string
produces:
- application/json
responses: {}
summary: 用户协议导出
tags:
- user_protocol-用户协议
/api/admin/user_protocol/ImportFile:
post:
produces:
- application/json
responses: {}
summary: 用户协议导入
tags:
- user_protocol-用户协议
/api/admin/user_protocol/add:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 标题
in: body
name: Title
schema:
type: string
- description: 协议内容
in: body
name: Content
schema:
type: string
- description: 排序
in: body
name: Sort
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 用户协议新增
tags:
- user_protocol-用户协议
/api/admin/user_protocol/del:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: Id
in: body
name: Id
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 用户协议删除
tags:
- user_protocol-用户协议
/api/admin/user_protocol/delBatch:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 逗号分割的id
in: body
name: Ids
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 用户协议删除-批量
tags:
- user_protocol-用户协议
/api/admin/user_protocol/detail:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: Id
in: query
name: Id
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
$ref: '#/definitions/user_protocol.UserProtocolResp'
type: object
summary: 用户协议详情
tags:
- user_protocol-用户协议
/api/admin/user_protocol/edit:
post:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: Id
in: body
name: Id
schema:
type: number
- description: 标题
in: body
name: Title
schema:
type: string
- description: 协议内容
in: body
name: Content
schema:
type: string
- description: 排序
in: body
name: Sort
schema:
type: number
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.Response'
summary: 用户协议编辑
tags:
- user_protocol-用户协议
/api/admin/user_protocol/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页数量
in: query
name: PageSize
required: true
type: integer
- description: 标题
in: query
name: Title
type: string
- description: 协议内容
in: query
name: Content
type: string
- description: 排序
in: query
name: Sort
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
- description: 更新时间
in: query
name: UpdateTimeStart
type: string
- description: 更新时间
in: query
name: UpdateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
allOf:
- $ref: '#/definitions/response.PageResp'
- properties:
' lists':
items:
$ref: '#/definitions/user_protocol.UserProtocolResp'
type: array
type: object
type: object
summary: 用户协议列表
tags:
- user_protocol-用户协议
/api/admin/user_protocol/listAll:
get:
parameters:
- description: 标题
in: query
name: Title
type: string
- description: 协议内容
in: query
name: Content
type: string
- description: 排序
in: query
name: Sort
type: number
- description: 创建时间
in: query
name: CreateTimeStart
type: string
- description: 创建时间
in: query
name: CreateTimeEnd
type: string
- description: 更新时间
in: query
name: UpdateTimeStart
type: string
- description: 更新时间
in: query
name: UpdateTimeEnd
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
' data':
items:
$ref: '#/definitions/user_protocol.UserProtocolResp'
type: array
type: object
summary: 用户协议列表-所有
tags:
- user_protocol-用户协议
/api/article_collect/list:
get:
parameters:
- description: token
in: header
name: Token
required: true
type: string
- description: 页码
in: query
name: PageNo
required: true
type: integer
- description: 每页大小
in: query
name: PageSize
required: true
type: integer
- description: 用户ID
in: query
name: userId
type: integer
- description: 文章ID
in: query
name: articleId
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/response.PageResp'
"400":
description: 请求错误
schema:
type: string
"500":
description: 内部错误
schema:
type: string
summary: article_collect列表
tags:
- article_collect文章
/system/admin/ListByDeptId/{deptId}:
get:
description: 获取部门的用户
parameters:
- description: 部门id
in: path
name: deptId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": []}'
schema:
$ref: '#/definitions/response.Response'
summary: 获取部门的用户
tags:
- 管理员
securityDefinitions:
BasicAuth:
type: basic
swagger: "2.0"