mirror of
https://github.com/xinliangnote/go-gin-api.git
synced 2024-04-21 12:31:46 +00:00
2208 lines
52 KiB
YAML
2208 lines
52 KiB
YAML
basePath: /
|
|
definitions:
|
|
admin.ListMenuData:
|
|
properties:
|
|
id:
|
|
description: ID
|
|
type: integer
|
|
is_have:
|
|
description: 是否已拥有权限
|
|
type: integer
|
|
name:
|
|
description: 菜单名称
|
|
type: string
|
|
pid:
|
|
description: 父类ID
|
|
type: integer
|
|
type: object
|
|
admin.ListMyMenuData:
|
|
properties:
|
|
icon:
|
|
description: 图标
|
|
type: string
|
|
id:
|
|
description: ID
|
|
type: integer
|
|
link:
|
|
description: 链接地址
|
|
type: string
|
|
name:
|
|
description: 菜单名称
|
|
type: string
|
|
pid:
|
|
description: 父类ID
|
|
type: integer
|
|
type: object
|
|
admin.createResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
admin.deleteResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
admin.detailResponse:
|
|
properties:
|
|
menu:
|
|
description: 菜单栏
|
|
items:
|
|
$ref: '#/definitions/admin.ListMyMenuData'
|
|
type: array
|
|
mobile:
|
|
description: 手机号
|
|
type: string
|
|
nickname:
|
|
description: 昵称
|
|
type: string
|
|
username:
|
|
description: 用户名
|
|
type: string
|
|
type: object
|
|
admin.listAdminMenuResponse:
|
|
properties:
|
|
list:
|
|
items:
|
|
$ref: '#/definitions/admin.ListMenuData'
|
|
type: array
|
|
username:
|
|
type: string
|
|
type: object
|
|
admin.listData:
|
|
properties:
|
|
created_at:
|
|
description: 创建时间
|
|
type: string
|
|
created_user:
|
|
description: 创建人
|
|
type: string
|
|
hashid:
|
|
description: hashid
|
|
type: string
|
|
id:
|
|
description: ID
|
|
type: integer
|
|
is_online:
|
|
description: 是否在线 1:是 -1:否
|
|
type: integer
|
|
is_used:
|
|
description: 是否启用 1:是 -1:否
|
|
type: integer
|
|
mobile:
|
|
description: 手机号
|
|
type: string
|
|
nickname:
|
|
description: 昵称
|
|
type: string
|
|
updated_at:
|
|
description: 更新时间
|
|
type: string
|
|
updated_user:
|
|
description: 更新人
|
|
type: string
|
|
username:
|
|
description: 用户名
|
|
type: string
|
|
type: object
|
|
admin.listResponse:
|
|
properties:
|
|
list:
|
|
items:
|
|
$ref: '#/definitions/admin.listData'
|
|
type: array
|
|
pagination:
|
|
properties:
|
|
current_page:
|
|
type: integer
|
|
per_page_count:
|
|
type: integer
|
|
total:
|
|
type: integer
|
|
type: object
|
|
type: object
|
|
admin.loginResponse:
|
|
properties:
|
|
token:
|
|
description: 用户身份标识
|
|
type: string
|
|
type: object
|
|
admin.logoutResponse:
|
|
properties:
|
|
username:
|
|
description: 用户账号
|
|
type: string
|
|
type: object
|
|
admin.modifyPasswordResponse:
|
|
properties:
|
|
username:
|
|
description: 用户账号
|
|
type: string
|
|
type: object
|
|
admin.modifyPersonalInfoResponse:
|
|
properties:
|
|
username:
|
|
description: 用户账号
|
|
type: string
|
|
type: object
|
|
admin.offlineResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
admin.resetPasswordResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
admin.updateUsedResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
authorized.createAPIResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
authorized.createResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
authorized.deleteAPIResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
authorized.deleteResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
authorized.listAPIData:
|
|
properties:
|
|
api:
|
|
description: 调用方对接人
|
|
type: string
|
|
business_key:
|
|
description: 调用方key
|
|
type: string
|
|
hash_id:
|
|
description: hashID
|
|
type: string
|
|
method:
|
|
description: 调用方secret
|
|
type: string
|
|
type: object
|
|
authorized.listAPIResponse:
|
|
properties:
|
|
business_key:
|
|
description: 调用方key
|
|
type: string
|
|
list:
|
|
items:
|
|
$ref: '#/definitions/authorized.listAPIData'
|
|
type: array
|
|
type: object
|
|
authorized.listData:
|
|
properties:
|
|
business_developer:
|
|
description: 调用方对接人
|
|
type: string
|
|
business_key:
|
|
description: 调用方key
|
|
type: string
|
|
business_secret:
|
|
description: 调用方secret
|
|
type: string
|
|
created_at:
|
|
description: 创建时间
|
|
type: string
|
|
created_user:
|
|
description: 创建人
|
|
type: string
|
|
hashid:
|
|
description: hashid
|
|
type: string
|
|
id:
|
|
description: ID
|
|
type: integer
|
|
is_used:
|
|
description: 是否启用 1:是 -1:否
|
|
type: integer
|
|
remark:
|
|
description: 备注
|
|
type: string
|
|
updated_at:
|
|
description: 更新时间
|
|
type: string
|
|
updated_user:
|
|
description: 更新人
|
|
type: string
|
|
type: object
|
|
authorized.listResponse:
|
|
properties:
|
|
list:
|
|
items:
|
|
$ref: '#/definitions/authorized.listData'
|
|
type: array
|
|
pagination:
|
|
properties:
|
|
current_page:
|
|
type: integer
|
|
per_page_count:
|
|
type: integer
|
|
total:
|
|
type: integer
|
|
type: object
|
|
type: object
|
|
authorized.updateUsedResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
code.Failure:
|
|
properties:
|
|
code:
|
|
description: 业务码
|
|
type: integer
|
|
message:
|
|
description: 描述信息
|
|
type: string
|
|
type: object
|
|
config.emailResponse:
|
|
properties:
|
|
email:
|
|
description: 邮箱地址
|
|
type: string
|
|
type: object
|
|
cron.createResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
cron.detailResponse:
|
|
properties:
|
|
command:
|
|
description: 执行命令
|
|
type: string
|
|
http_method:
|
|
description: http 请求方式 1:get 2:post
|
|
type: integer
|
|
is_used:
|
|
description: 是否启用 1:是 -1:否
|
|
type: integer
|
|
name:
|
|
description: 任务名称
|
|
type: string
|
|
notify_keyword:
|
|
description: 通知匹配关键字(多个用,分割)
|
|
type: string
|
|
notify_receiver_email:
|
|
description: 通知者邮箱地址(多个用,分割)
|
|
type: string
|
|
notify_status:
|
|
description: 执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知
|
|
type: integer
|
|
notify_type:
|
|
description: 通知类型 1:邮件 2:webhook
|
|
type: integer
|
|
protocol:
|
|
description: 执行方式 1:shell 2:http
|
|
type: integer
|
|
remark:
|
|
description: 备注
|
|
type: string
|
|
retry_interval:
|
|
description: 重试间隔(单位:秒)
|
|
type: integer
|
|
retry_times:
|
|
description: 重试次数
|
|
type: integer
|
|
spec:
|
|
description: crontab 表达式
|
|
type: string
|
|
timeout:
|
|
description: 超时时间(单位:秒)
|
|
type: integer
|
|
type: object
|
|
cron.listData:
|
|
properties:
|
|
command:
|
|
description: 执行命令
|
|
type: string
|
|
created_at:
|
|
description: 创建时间
|
|
type: string
|
|
created_user:
|
|
description: 创建人
|
|
type: string
|
|
hashid:
|
|
description: hashid
|
|
type: string
|
|
http_method:
|
|
description: http 请求方式 1:get 2:post
|
|
type: integer
|
|
http_method_text:
|
|
description: http 请求方式
|
|
type: string
|
|
id:
|
|
description: ID
|
|
type: integer
|
|
is_used:
|
|
description: 是否启用 1=启用 2=禁用
|
|
type: integer
|
|
is_used_text:
|
|
description: 是否启用
|
|
type: string
|
|
name:
|
|
description: 任务名称
|
|
type: string
|
|
notify_status:
|
|
description: 执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知
|
|
type: integer
|
|
notify_status_text:
|
|
description: 执行结束是否通知
|
|
type: string
|
|
protocol:
|
|
description: 执行方式 1:shell 2:http
|
|
type: integer
|
|
protocol_text:
|
|
description: 执行方式
|
|
type: string
|
|
retry_interval:
|
|
description: 重试间隔(单位:秒)
|
|
type: integer
|
|
retry_times:
|
|
description: 重试次数
|
|
type: integer
|
|
spec:
|
|
description: crontab 表达式
|
|
type: string
|
|
timeout:
|
|
description: 超时时间(单位:秒)
|
|
type: integer
|
|
updated_at:
|
|
description: 更新时间
|
|
type: string
|
|
updated_user:
|
|
description: 更新人
|
|
type: string
|
|
type: object
|
|
cron.listResponse:
|
|
properties:
|
|
list:
|
|
items:
|
|
$ref: '#/definitions/cron.listData'
|
|
type: array
|
|
pagination:
|
|
properties:
|
|
current_page:
|
|
type: integer
|
|
per_page_count:
|
|
type: integer
|
|
total:
|
|
type: integer
|
|
type: object
|
|
type: object
|
|
cron.modifyResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
cron.updateUsedResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
helper.md5Response:
|
|
properties:
|
|
md5_str:
|
|
description: MD5后的字符串
|
|
type: string
|
|
type: object
|
|
helper.signResponse:
|
|
properties:
|
|
authorization:
|
|
description: 签名信息-Authorization
|
|
type: string
|
|
authorization_date:
|
|
description: 签名信息-Authorization-Date
|
|
type: string
|
|
type: object
|
|
menu.createActionResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
menu.createRequest:
|
|
properties:
|
|
icon:
|
|
description: 图标
|
|
type: string
|
|
id:
|
|
description: ID
|
|
type: string
|
|
level:
|
|
description: 菜单类型 1:一级菜单 2:二级菜单
|
|
type: integer
|
|
link:
|
|
description: 链接地址
|
|
type: string
|
|
name:
|
|
description: 菜单名称
|
|
type: string
|
|
pid:
|
|
description: 父类ID
|
|
type: integer
|
|
type: object
|
|
menu.createResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
menu.deleteActionResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
menu.deleteResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
menu.detailResponse:
|
|
properties:
|
|
icon:
|
|
description: 图标
|
|
type: string
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
link:
|
|
description: 链接地址
|
|
type: string
|
|
name:
|
|
description: 菜单名称
|
|
type: string
|
|
pid:
|
|
description: 父类ID
|
|
type: integer
|
|
type: object
|
|
menu.listActionData:
|
|
properties:
|
|
api:
|
|
description: 调用方对接人
|
|
type: string
|
|
hash_id:
|
|
description: hashID
|
|
type: string
|
|
menu_id:
|
|
description: 菜单栏ID
|
|
type: integer
|
|
method:
|
|
description: 调用方secret
|
|
type: string
|
|
type: object
|
|
menu.listActionResponse:
|
|
properties:
|
|
list:
|
|
items:
|
|
$ref: '#/definitions/menu.listActionData'
|
|
type: array
|
|
menu_name:
|
|
type: string
|
|
type: object
|
|
menu.listData:
|
|
properties:
|
|
hashid:
|
|
description: hashid
|
|
type: string
|
|
icon:
|
|
description: 图标
|
|
type: string
|
|
id:
|
|
description: ID
|
|
type: integer
|
|
is_used:
|
|
description: 是否启用 1=启用 -1=禁用
|
|
type: integer
|
|
link:
|
|
description: 链接地址
|
|
type: string
|
|
name:
|
|
description: 菜单名称
|
|
type: string
|
|
pid:
|
|
description: 父类ID
|
|
type: integer
|
|
sort:
|
|
description: 排序
|
|
type: integer
|
|
type: object
|
|
menu.listResponse:
|
|
properties:
|
|
list:
|
|
items:
|
|
$ref: '#/definitions/menu.listData'
|
|
type: array
|
|
type: object
|
|
menu.updateSortResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
menu.updateUsedResponse:
|
|
properties:
|
|
id:
|
|
description: 主键ID
|
|
type: integer
|
|
type: object
|
|
tool.dbData:
|
|
properties:
|
|
db_name:
|
|
description: 数据库名称
|
|
type: string
|
|
type: object
|
|
tool.dbsResponse:
|
|
properties:
|
|
list:
|
|
description: 数据库列表
|
|
items:
|
|
$ref: '#/definitions/tool.dbData'
|
|
type: array
|
|
type: object
|
|
tool.hashIdsDecodeResponse:
|
|
properties:
|
|
val:
|
|
description: 解密后的值
|
|
type: integer
|
|
type: object
|
|
tool.hashIdsEncodeResponse:
|
|
properties:
|
|
val:
|
|
description: 加密后的值
|
|
type: string
|
|
type: object
|
|
tool.searchCacheResponse:
|
|
properties:
|
|
ttl:
|
|
description: 过期时间
|
|
type: string
|
|
val:
|
|
description: 查询后的值
|
|
type: string
|
|
type: object
|
|
tool.searchMySQLResponse:
|
|
properties:
|
|
cols:
|
|
description: 查询后的行
|
|
items:
|
|
type: string
|
|
type: array
|
|
cols_info:
|
|
description: 行信息
|
|
items:
|
|
$ref: '#/definitions/tool.tableColumn'
|
|
type: array
|
|
list:
|
|
description: 查询后的数据
|
|
items:
|
|
additionalProperties: true
|
|
type: object
|
|
type: array
|
|
type: object
|
|
tool.sendMessageResponse:
|
|
properties:
|
|
status:
|
|
description: 状态
|
|
type: string
|
|
type: object
|
|
tool.tableColumn:
|
|
properties:
|
|
column_comment:
|
|
description: 字段注释
|
|
type: string
|
|
column_name:
|
|
description: 字段名称
|
|
type: string
|
|
type: object
|
|
tool.tableData:
|
|
properties:
|
|
table_comment:
|
|
description: 数据表备注
|
|
type: string
|
|
table_name:
|
|
description: 数据表名称
|
|
type: string
|
|
type: object
|
|
tool.tablesResponse:
|
|
properties:
|
|
list:
|
|
description: 数据表列表
|
|
items:
|
|
$ref: '#/definitions/tool.tableData'
|
|
type: array
|
|
type: object
|
|
info:
|
|
contact: {}
|
|
license:
|
|
name: MIT
|
|
url: https://github.com/xinliangnote/go-gin-api/blob/master/LICENSE
|
|
title: swagger 接口文档
|
|
version: "2.0"
|
|
paths:
|
|
/api/admin:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 管理员列表
|
|
parameters:
|
|
- default: 1
|
|
description: 第几页
|
|
in: query
|
|
name: page
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: 每页显示条数
|
|
in: query
|
|
name: page_size
|
|
required: true
|
|
type: integer
|
|
- description: 用户名
|
|
in: query
|
|
name: username
|
|
type: string
|
|
- description: 昵称
|
|
in: query
|
|
name: nickname
|
|
type: string
|
|
- description: 手机号
|
|
in: query
|
|
name: mobile
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.listResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 管理员列表
|
|
tags:
|
|
- API.admin
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 新增管理员
|
|
parameters:
|
|
- description: 用户名
|
|
in: formData
|
|
name: username
|
|
required: true
|
|
type: string
|
|
- description: 昵称
|
|
in: formData
|
|
name: nickname
|
|
required: true
|
|
type: string
|
|
- description: 手机号
|
|
in: formData
|
|
name: mobile
|
|
required: true
|
|
type: string
|
|
- description: MD5后的密码
|
|
in: formData
|
|
name: password
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.createResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 新增管理员
|
|
tags:
|
|
- API.admin
|
|
/api/admin/{id}:
|
|
delete:
|
|
consumes:
|
|
- application/json
|
|
description: 删除管理员
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.deleteResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 删除管理员
|
|
tags:
|
|
- API.admin
|
|
/api/admin/info:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 管理员详情
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.detailResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 管理员详情
|
|
tags:
|
|
- API.admin
|
|
/api/admin/logout:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 管理员登出
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.logoutResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 管理员登出
|
|
tags:
|
|
- API.admin
|
|
/api/admin/menu:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 提交菜单授权
|
|
parameters:
|
|
- description: Hashid
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 功能权限ID,多个用,分割
|
|
in: formData
|
|
name: actions
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.createResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 提交菜单授权
|
|
tags:
|
|
- API.admin
|
|
/api/admin/menu/{id}:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 菜单授权列表
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.listAdminMenuResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 菜单授权列表
|
|
tags:
|
|
- API.admin
|
|
/api/admin/modify_password:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 修改密码
|
|
parameters:
|
|
- description: 旧密码
|
|
in: formData
|
|
name: old_password
|
|
required: true
|
|
type: string
|
|
- description: 新密码
|
|
in: formData
|
|
name: new_password
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.modifyPasswordResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 修改密码
|
|
tags:
|
|
- API.admin
|
|
/api/admin/modify_personal_info:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 修改个人信息
|
|
parameters:
|
|
- description: 昵称
|
|
in: formData
|
|
name: nickname
|
|
required: true
|
|
type: string
|
|
- description: 手机号
|
|
in: formData
|
|
name: mobile
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.modifyPersonalInfoResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 修改个人信息
|
|
tags:
|
|
- API.admin
|
|
/api/admin/offline:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 下线管理员
|
|
parameters:
|
|
- description: Hashid
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.offlineResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 下线管理员
|
|
tags:
|
|
- API.admin
|
|
/api/admin/reset_password/{id}:
|
|
patch:
|
|
consumes:
|
|
- application/json
|
|
description: 重置密码
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.resetPasswordResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 重置密码
|
|
tags:
|
|
- API.admin
|
|
/api/admin/used:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 更新管理员为启用/禁用
|
|
parameters:
|
|
- description: Hashid
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 是否启用 1:是 -1:否
|
|
in: formData
|
|
name: used
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.updateUsedResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 更新管理员为启用/禁用
|
|
tags:
|
|
- API.admin
|
|
/api/authorized:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 调用方列表
|
|
parameters:
|
|
- default: 1
|
|
description: 第几页
|
|
in: query
|
|
name: page
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: 每页显示条数
|
|
in: query
|
|
name: page_size
|
|
required: true
|
|
type: integer
|
|
- description: 调用方key
|
|
in: query
|
|
name: business_key
|
|
type: string
|
|
- description: 调用方secret
|
|
in: query
|
|
name: business_secret
|
|
type: string
|
|
- description: 调用方对接人
|
|
in: query
|
|
name: business_developer
|
|
type: string
|
|
- description: 备注
|
|
in: path
|
|
name: remark
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/authorized.listResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 调用方列表
|
|
tags:
|
|
- API.authorized
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 新增调用方
|
|
parameters:
|
|
- description: 调用方key
|
|
in: formData
|
|
name: business_key
|
|
required: true
|
|
type: string
|
|
- description: 调用方对接人
|
|
in: formData
|
|
name: business_developer
|
|
required: true
|
|
type: string
|
|
- description: 备注
|
|
in: formData
|
|
name: remark
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/authorized.createResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 新增调用方
|
|
tags:
|
|
- API.authorized
|
|
/api/authorized/{id}:
|
|
delete:
|
|
consumes:
|
|
- application/json
|
|
description: 删除调用方
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/authorized.deleteResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 删除调用方
|
|
tags:
|
|
- API.authorized
|
|
/api/authorized/used:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 更新调用方为启用/禁用
|
|
parameters:
|
|
- description: hashID
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 是否启用 1:是 -1:否
|
|
in: formData
|
|
name: used
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/authorized.updateUsedResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 更新调用方为启用/禁用
|
|
tags:
|
|
- API.authorized
|
|
/api/authorized_api:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 调用方接口地址列表
|
|
parameters:
|
|
- description: hashID
|
|
in: query
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/authorized.listAPIResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 调用方接口地址列表
|
|
tags:
|
|
- API.authorized
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 授权调用方接口地址
|
|
parameters:
|
|
- description: HashID
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 请求方法
|
|
in: formData
|
|
name: method
|
|
required: true
|
|
type: string
|
|
- description: 请求地址
|
|
in: formData
|
|
name: api
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/authorized.createAPIResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 授权调用方接口地址
|
|
tags:
|
|
- API.authorized
|
|
/api/authorized_api/{id}:
|
|
delete:
|
|
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/authorized.deleteAPIResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 删除调用方接口地址
|
|
tags:
|
|
- API.authorized
|
|
/api/config/email:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 修改邮件配置
|
|
parameters:
|
|
- description: 邮箱服务器
|
|
in: formData
|
|
name: host
|
|
required: true
|
|
type: string
|
|
- description: 端口
|
|
in: formData
|
|
name: port
|
|
required: true
|
|
type: string
|
|
- description: 发件人邮箱
|
|
in: formData
|
|
name: user
|
|
required: true
|
|
type: string
|
|
- description: 发件人密码
|
|
in: formData
|
|
name: pass
|
|
required: true
|
|
type: string
|
|
- description: 收件人邮箱地址，多个用,分割
|
|
in: formData
|
|
name: to
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/config.emailResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 修改邮件配置
|
|
tags:
|
|
- API.config
|
|
/api/cron:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 任务列表
|
|
parameters:
|
|
- default: 1
|
|
description: 第几页
|
|
in: query
|
|
name: page
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: 每页显示条数
|
|
in: query
|
|
name: page_size
|
|
required: true
|
|
type: integer
|
|
- description: 任务名称
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: 执行方式 1:shell 2:http
|
|
in: query
|
|
name: protocol
|
|
type: integer
|
|
- description: 是否启用 1:是 -1:否
|
|
in: query
|
|
name: is_used
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/cron.listResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 任务列表
|
|
tags:
|
|
- API.cron
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 创建任务
|
|
parameters:
|
|
- description: 任务名称
|
|
in: formData
|
|
name: name
|
|
required: true
|
|
type: string
|
|
- description: crontab 表达式
|
|
in: formData
|
|
name: spec
|
|
required: true
|
|
type: string
|
|
- description: 执行命令
|
|
in: formData
|
|
name: command
|
|
required: true
|
|
type: string
|
|
- description: 执行方式 1:shell 2:http
|
|
in: formData
|
|
name: protocol
|
|
required: true
|
|
type: integer
|
|
- description: http 请求方式 1:get 2:post
|
|
in: formData
|
|
name: http_method
|
|
type: integer
|
|
- description: 超时时间(单位:秒)
|
|
in: formData
|
|
name: timeout
|
|
required: true
|
|
type: integer
|
|
- description: 重试次数
|
|
in: formData
|
|
name: retry_times
|
|
required: true
|
|
type: integer
|
|
- description: 重试间隔(单位:秒)
|
|
in: formData
|
|
name: retry_interval
|
|
required: true
|
|
type: integer
|
|
- description: 执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知
|
|
in: formData
|
|
name: notify_status
|
|
required: true
|
|
type: integer
|
|
- description: 通知类型 1:邮件 2:webhook
|
|
in: formData
|
|
name: notify_type
|
|
type: integer
|
|
- description: 通知者邮箱地址(多个用,分割)
|
|
in: formData
|
|
name: notify_receiver_email
|
|
type: string
|
|
- description: 通知匹配关键字(多个用,分割)
|
|
in: formData
|
|
name: notify_keyword
|
|
type: string
|
|
- description: 备注
|
|
in: formData
|
|
name: remark
|
|
type: string
|
|
- description: 是否启用 1:是 -1:否
|
|
in: formData
|
|
name: is_used
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/cron.createResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 创建任务
|
|
tags:
|
|
- API.cron
|
|
/api/cron/{id}:
|
|
get:
|
|
consumes:
|
|
- application/json
|
|
description: 获取单条任务详情
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/cron.detailResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 获取单条任务详情
|
|
tags:
|
|
- API.cron
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 编辑任务
|
|
parameters:
|
|
- description: hashID
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 任务名称
|
|
in: formData
|
|
name: name
|
|
required: true
|
|
type: string
|
|
- description: crontab 表达式
|
|
in: formData
|
|
name: spec
|
|
required: true
|
|
type: string
|
|
- description: 执行命令
|
|
in: formData
|
|
name: command
|
|
required: true
|
|
type: string
|
|
- description: 执行方式 1:shell 2:http
|
|
in: formData
|
|
name: protocol
|
|
required: true
|
|
type: integer
|
|
- description: http 请求方式 1:get 2:post
|
|
in: formData
|
|
name: http_method
|
|
type: integer
|
|
- description: 超时时间(单位:秒)
|
|
in: formData
|
|
name: timeout
|
|
required: true
|
|
type: integer
|
|
- description: 重试次数
|
|
in: formData
|
|
name: retry_times
|
|
required: true
|
|
type: integer
|
|
- description: 重试间隔(单位:秒)
|
|
in: formData
|
|
name: retry_interval
|
|
required: true
|
|
type: integer
|
|
- description: 执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知
|
|
in: formData
|
|
name: notify_status
|
|
required: true
|
|
type: integer
|
|
- description: 通知类型 1:邮件 2:webhook
|
|
in: formData
|
|
name: notify_type
|
|
type: integer
|
|
- description: 通知者邮箱地址(多个用,分割)
|
|
in: formData
|
|
name: notify_receiver_email
|
|
type: string
|
|
- description: 通知匹配关键字(多个用,分割)
|
|
in: formData
|
|
name: notify_keyword
|
|
type: string
|
|
- description: 备注
|
|
in: formData
|
|
name: remark
|
|
type: string
|
|
- description: 是否启用 1:是 -1:否
|
|
in: formData
|
|
name: is_used
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/cron.modifyResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 编辑任务
|
|
tags:
|
|
- API.cron
|
|
/api/cron/exec/{id}:
|
|
patch:
|
|
consumes:
|
|
- application/json
|
|
description: 手动执行单条任务
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/cron.detailResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 手动执行单条任务
|
|
tags:
|
|
- API.cron
|
|
/api/cron/used:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 更新任务为启用/禁用
|
|
parameters:
|
|
- description: hashID
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 是否启用 1:是 -1:否
|
|
in: formData
|
|
name: used
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/cron.updateUsedResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 更新任务为启用/禁用
|
|
tags:
|
|
- API.cron
|
|
/api/login:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 管理员登录
|
|
parameters:
|
|
- description: 用户名
|
|
in: formData
|
|
name: username
|
|
required: true
|
|
type: string
|
|
- description: MD5后的密码
|
|
in: formData
|
|
name: password
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/admin.loginResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 管理员登录
|
|
tags:
|
|
- API.admin
|
|
/api/menu:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 菜单列表
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.listResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 菜单列表
|
|
tags:
|
|
- API.menu
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 创建/编辑菜单
|
|
parameters:
|
|
- description: 请求信息
|
|
in: body
|
|
name: Request
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/menu.createRequest'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.createResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 创建/编辑菜单
|
|
tags:
|
|
- API.menu
|
|
/api/menu/{id}:
|
|
delete:
|
|
consumes:
|
|
- application/json
|
|
description: 删除菜单
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.deleteResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 删除菜单
|
|
tags:
|
|
- API.menu
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 菜单详情
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.detailResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 菜单详情
|
|
tags:
|
|
- API.menu
|
|
/api/menu/sort:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 更新菜单排序
|
|
parameters:
|
|
- description: hashId
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 排序
|
|
in: formData
|
|
name: sort
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.updateSortResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 更新菜单排序
|
|
tags:
|
|
- API.menu
|
|
/api/menu/used:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 更新菜单为启用/禁用
|
|
parameters:
|
|
- description: hashId
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 是否启用 1:是 -1:否
|
|
in: formData
|
|
name: used
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.updateUsedResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 更新菜单为启用/禁用
|
|
tags:
|
|
- API.menu
|
|
/api/menu_action:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 功能权限列表
|
|
parameters:
|
|
- description: hashID
|
|
in: query
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.listActionResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 功能权限列表
|
|
tags:
|
|
- API.menu
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 创建功能权限
|
|
parameters:
|
|
- description: HashID
|
|
in: formData
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: 请求方法
|
|
in: formData
|
|
name: method
|
|
required: true
|
|
type: string
|
|
- description: 请求地址
|
|
in: formData
|
|
name: api
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.createActionResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 创建功能权限
|
|
tags:
|
|
- API.menu
|
|
/api/menu_action/{id}:
|
|
delete:
|
|
consumes:
|
|
- application/json
|
|
description: 删除功能权限
|
|
parameters:
|
|
- description: hashId
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/menu.deleteActionResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 删除功能权限
|
|
tags:
|
|
- API.menu
|
|
/api/tool/cache/clear:
|
|
patch:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 清空缓存
|
|
parameters:
|
|
- description: Redis Key
|
|
in: formData
|
|
name: redis_key
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.searchCacheResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 清空缓存
|
|
tags:
|
|
- API.tool
|
|
/api/tool/cache/search:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 查询缓存
|
|
parameters:
|
|
- description: Redis Key
|
|
in: formData
|
|
name: redis_key
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.searchCacheResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 查询缓存
|
|
tags:
|
|
- API.tool
|
|
/api/tool/data/dbs:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 查询 DB
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.dbsResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 查询 DB
|
|
tags:
|
|
- API.tool
|
|
/api/tool/data/mysql:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 执行 SQL 语句
|
|
parameters:
|
|
- description: 数据库名称
|
|
in: formData
|
|
name: db_name
|
|
required: true
|
|
type: string
|
|
- description: 数据表名称
|
|
in: formData
|
|
name: table_name
|
|
required: true
|
|
type: string
|
|
- description: SQL 语句
|
|
in: formData
|
|
name: sql
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.searchMySQLResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 执行 SQL 语句
|
|
tags:
|
|
- API.tool
|
|
/api/tool/data/tables:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 查询 Table
|
|
parameters:
|
|
- description: 数据库名称
|
|
in: formData
|
|
name: db_name
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.tablesResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 查询 Table
|
|
tags:
|
|
- API.tool
|
|
/api/tool/hashids/decode/{id}:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: HashIds 解密
|
|
parameters:
|
|
- description: 需解密的密文
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.hashIdsDecodeResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: HashIds 解密
|
|
tags:
|
|
- API.tool
|
|
/api/tool/hashids/encode/{id}:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: HashIds 加密
|
|
parameters:
|
|
- description: 需加密的数字
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.hashIdsEncodeResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: HashIds 加密
|
|
tags:
|
|
- API.tool
|
|
/api/tool/send_message:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 发送消息
|
|
parameters:
|
|
- description: 消息内容
|
|
in: formData
|
|
name: message
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/tool.sendMessageResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
security:
|
|
- LoginToken: []
|
|
summary: 发送消息
|
|
tags:
|
|
- API.tool
|
|
/helper/md5/{str}:
|
|
get:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 加密
|
|
parameters:
|
|
- description: 需要加密的字符串
|
|
in: path
|
|
name: str
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/helper.md5Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
summary: 加密
|
|
tags:
|
|
- Helper
|
|
/helper/sign:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
description: 签名
|
|
parameters:
|
|
- description: 调用方 KEY
|
|
in: formData
|
|
name: key
|
|
required: true
|
|
type: string
|
|
- description: 请求路径 (不附带 querystring)，例如：/api/login
|
|
in: formData
|
|
name: path
|
|
required: true
|
|
type: string
|
|
- description: 请求方式，例如：POST
|
|
in: formData
|
|
name: method
|
|
required: true
|
|
type: string
|
|
- description: 请求参数，例如：username=tom&password=123456
|
|
in: formData
|
|
name: params
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/helper.signResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/code.Failure'
|
|
summary: 签名
|
|
tags:
|
|
- Helper
|
|
securityDefinitions:
|
|
LoginToken:
|
|
in: header
|
|
name: token
|
|
type: apiKey
|
|
swagger: "2.0"
|