|
|
basePath: /
definitions:
api.AddMenuAuthorityInfo:
properties:
authorityId:
type: string
menus:
items:
$ref: '#/definitions/sysModel.SysBaseMenu'
type: array
type: object
api.AuthorityIdInfo:
properties:
authorityId:
type: string
type: object
api.ChangePasswordStutrc:
properties:
newPassword:
type: string
password:
type: string
username:
type: string
type: object
api.CreateApiParams:
properties:
description:
type: string
path:
type: string
type: object
api.CreateAuthorityParams:
properties:
authorityId:
type: string
authorityName:
type: string
type: object
api.DeleteAuthorityPatams:
properties:
authorityId:
type: integer
type: object
api.GetById:
properties:
id:
type: number
type: object
api.IdInfo:
properties:
id:
type: number
type: object
api.RegisterAndLoginStruct:
properties:
captcha:
type: string
captchaId:
type: string
password:
type: string
username:
type: string
type: object
api.SetUserAuth:
properties:
authorityId:
type: string
uuid:
type: string
type: object
config.CasbinConfig:
properties:
modelPath:
description: casbin model地址配置
type: string
type: object
config.Config:
properties:
casbinConfig:
$ref: '#/definitions/config.CasbinConfig'
type: object
jwt:
$ref: '#/definitions/config.JWT'
type: object
mysqlAdmin:
$ref: '#/definitions/config.MysqlAdmin'
type: object
qiniu:
$ref: '#/definitions/config.Qiniu'
type: object
redisAdmin:
$ref: '#/definitions/config.RedisAdmin'
type: object
system:
$ref: '#/definitions/config.System'
type: object
type: object
config.JWT:
properties:
signingKey:
type: string
type: object
config.MysqlAdmin:
properties:
config:
type: string
dbname:
type: string
password:
type: string
path:
type: string
username:
type: string
type: object
config.Qiniu:
properties:
accessKey:
type: string
secretKey:
type: string
type: object
config.RedisAdmin:
properties:
addr:
type: string
db:
type: integer
password:
type: string
type: object
config.System:
properties:
addr:
type: integer
env:
type: string
useMultipoint:
type: boolean
type: object
dbModel.ExaCustomer:
properties:
customerName:
type: string
customerPhoneData:
type: string
sysUser:
$ref: '#/definitions/sysModel.SysUser'
type: object
sysUserAuthorityID:
type: string
sysUserId:
type: integer
type: object
dbModel.ExaFileUploadAndDownload:
properties:
key:
type: string
name:
type: string
tag:
type: string
url:
type: string
type: object
model.PageInfo:
properties:
page:
type: integer
pageSize:
type: integer
type: object
sysModel.CasbinInReceive:
properties:
authorityId:
type: string
casbinInfos:
items:
$ref: '#/definitions/sysModel.CasbinInfo'
type: array
type: object
sysModel.CasbinInfo:
properties:
method:
type: string
path:
type: string
type: object
sysModel.SysApi:
properties:
description:
type: string
group:
type: string
method:
type: string
path:
type: string
type: object
sysModel.SysAuthority:
properties:
authorityId:
type: string
authorityName:
type: string
children:
items:
$ref: '#/definitions/sysModel.SysAuthority'
type: array
dataAuthorityId:
items:
$ref: '#/definitions/sysModel.SysAuthority'
type: array
parentId:
type: string
type: object
sysModel.SysBaseMenu:
properties:
children:
items:
$ref: '#/definitions/sysModel.SysBaseMenu'
type: array
component:
type: string
hidden:
type: boolean
icon:
type: string
name:
type: string
nickName:
type: string
parentId:
type: string
path:
type: string
sort:
type: string
title:
type: string
type: object
sysModel.SysUser:
properties:
authority:
$ref: '#/definitions/sysModel.SysAuthority'
type: object
authorityId:
type: string
headerImg:
type: string
nickName:
type: string
userName:
type: string
uuid:
type: string
type: object
sysModel.SysWorkflow:
properties:
workflowDescription:
description: 工作流描述
type: string
workflowName:
description: 工作流英文id
type: string
workflowNickName:
description: 工作流名称
type: string
workflowStep:
description: 工作流步骤
items:
$ref: '#/definitions/sysModel.SysWorkflowStepInfo'
type: array
type: object
sysModel.SysWorkflowStepInfo:
properties:
isEnd:
description: 是否是完结流节点
type: boolean
isStrat:
description: 是否是开始流节点
type: boolean
stepAuthorityID:
description: 操作者级别id
type: string
stepName:
description: 工作流名称
type: string
stepNo:
description: 步骤id （第几步）
type: number
workflowID:
description: 所属工作流ID
type: integer
type: object
sysModel.System:
properties:
config:
$ref: '#/definitions/config.Config'
type: object
type: object
info:
contact: {}
description: This is a sample Server pets
license: {}
title: Swagger Example API
version: 0.0.1
paths:
/api/createApi:
post:
consumes:
- application/json
parameters:
- description: 创建api
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateApiParams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 创建基础api
tags:
- SysApi
/api/deleteApi:
post:
consumes:
- application/json
parameters:
- description: 删除api
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.SysApi'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除指定api
tags:
- SysApi
/api/getAllApis:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取所有的Api 不分页
tags:
- SysApi
/api/getApiById:
post:
consumes:
- application/json
parameters:
- description: 分页获取用户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 根据id获取api
tags:
- SysApi
/api/getApiList:
post:
consumes:
- application/json
parameters:
- description: 分页获取API列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取API列表
tags:
- SysApi
/api/updateApi:
post:
consumes:
- application/json
parameters:
- description: 创建api
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateApiParams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 创建基础api
tags:
- SysApi
/authority/createAuthority:
post:
consumes:
- application/json
parameters:
- description: 创建角色
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateAuthorityParams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 创建角色
tags:
- authority
/authority/deleteAuthority:
post:
consumes:
- application/json
parameters:
- description: 删除角色
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.DeleteAuthorityPatams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除角色
tags:
- authority
/authority/getAuthorityList:
post:
consumes:
- application/json
parameters:
- description: 分页获取用户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取角色列表
tags:
- authority
/authority/setDataAuthority:
post:
consumes:
- application/json
parameters:
- description: 设置角色资源权限
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.SysAuthority'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"设置成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 设置角色资源权限
tags:
- authority
/base/captcha:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 生成验证码
tags:
- base
/base/captcha/:
get:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 生成验证码图片路径
tags:
- base
/base/login:
post:
parameters:
- description: 用户登录接口
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.RegisterAndLoginStruct'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"登陆成功"}'
schema:
type: string
summary: 用户登录
tags:
- Base
/base/register:
post:
parameters:
- description: 用户注册接口
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.SysUser'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"注册成功"}'
schema:
type: string
summary: 用户注册账号
tags:
- Base
/casbin/CasbinTest:
get:
consumes:
- application/json
parameters:
- description: 获取权限列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateAuthorityParams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: casb RBAC RESTFUL测试路由
tags:
- casbin
/casbin/UpdateCasbin:
post:
consumes:
- application/json
parameters:
- description: 更改角色api权限
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.CasbinInReceive'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 更改角色api权限
tags:
- casbin
/casbin/getPolicyPathByAuthorityId:
post:
consumes:
- application/json
parameters:
- description: 获取权限列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateAuthorityParams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取权限列表
tags:
- casbin
/customer/createExaCustomer:
post:
consumes:
- application/json
parameters:
- description: 创建客户
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.ExaCustomer'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 创建客户
tags:
- SysApi
/customer/deleteExaCustomer:
post:
consumes:
- application/json
parameters:
- description: 删除客户
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.ExaCustomer'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除客户
tags:
- SysApi
/customer/getExaCustomer:
post:
consumes:
- application/json
parameters:
- description: 获取单一客户信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.ExaCustomer'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取单一客户信息
tags:
- SysApi
/customer/getExaCustomerList:
post:
consumes:
- application/json
parameters:
- description: 获取权限客户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取权限客户列表
tags:
- SysApi
/customer/updateExaCustomer:
post:
consumes:
- application/json
parameters:
- description: 创建客户
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.ExaCustomer'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 更新客户信息
tags:
- SysApi
/fileUploadAndDownload/breakpointContinue:
post:
consumes:
- multipart/form-data
parameters:
- description: 断点续传示例
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"上传成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 断点续传到服务器
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/deleteFile:
post:
parameters:
- description: 传入文件里面id即可
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.ExaFileUploadAndDownload'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"返回成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除文件
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/findFile:
post:
consumes:
- multipart/form-data
parameters:
- description: 查找文件
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"查找成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 查找文件
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/getFileList:
post:
consumes:
- application/json
parameters:
- description: 分页获取文件户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页文件列表
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/removeChunk:
post:
consumes:
- multipart/form-data
parameters:
- description: 查找文件
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"查找成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除切片
tags:
- ExaFileUploadAndDownload
/fileUploadAndDownload/upload:
post:
consumes:
- multipart/form-data
parameters:
- description: 上传文件示例
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"上传成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 上传文件示例
tags:
- ExaFileUploadAndDownload
/jwt/jsonInBlacklist:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"拉黑成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: jwt加入黑名单
tags:
- jwt
/menu/addBaseMenu:
post:
consumes:
- application/json
parameters:
- description: 新增菜单
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.SysBaseMenu'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 新增菜单
tags:
- menu
/menu/addMenuAuthority:
post:
consumes:
- application/json
parameters:
- description: 增加menu和角色关联关系
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.AuthorityIdInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取指定角色menu
tags:
- authorityAndMenu
/menu/deleteBaseMenu:
post:
consumes:
- application/json
parameters:
- description: 删除菜单
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.IdInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除菜单
tags:
- menu
/menu/getBaseMenuById:
post:
consumes:
- application/json
parameters:
- description: 根据id获取菜单
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.GetById'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 根据id获取菜单
tags:
- menu
/menu/getBaseMenuTree:
post:
parameters:
- description: 可以什么都不填
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.RegisterAndLoginStruct'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"返回成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取用户动态路由
tags:
- authorityAndMenu
/menu/getMenu:
post:
parameters:
- description: 可以什么都不填
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.RegisterAndLoginStruct'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"返回成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取用户动态路由
tags:
- authorityAndMenu
/menu/getMenuList:
post:
consumes:
- application/json
parameters:
- description: 分页获取基础menu列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取基础menu列表
tags:
- menu
/menu/updateBaseMen:
post:
consumes:
- application/json
parameters:
- description: 更新菜单
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.SysBaseMenu'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 更新菜单
tags:
- menu
/system/ReloadSystem:
post:
parameters:
- description: 设置配置文件内容
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.System'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"返回成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 设置配置文件内容
tags:
- system
/system/getSystemConfig:
post:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"返回成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取配置文件内容
tags:
- system
/system/setSystemConfig:
post:
parameters:
- description: 设置配置文件内容
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.System'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"返回成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 设置配置文件内容
tags:
- system
/user/changePassword:
post:
parameters:
- description: 用户修改密码
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.ChangePasswordStutrc'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 用户修改密码
tags:
- SysUser
/user/getUserList:
post:
consumes:
- application/json
parameters:
- description: 分页获取用户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/model.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取用户列表
tags:
- SysUser
/user/setUserAuthority:
post:
consumes:
- application/json
parameters:
- description: 设置用户权限
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.SetUserAuth'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 设置用户权限
tags:
- SysUser
/user/uploadHeaderImg:
post:
consumes:
- multipart/form-data
parameters:
- description: 用户上传头像
in: formData
name: headerImg
required: true
type: file
- description: 用户上传头像
in: formData
name: username
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"上传成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 用户上传头像
tags:
- SysUser
/workflow/createWorkFlow:
post:
parameters:
- description: 注册工作流接口
in: body
name: data
required: true
schema:
$ref: '#/definitions/sysModel.SysWorkflow'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"注册成功"}'
schema:
type: string
summary: 注册工作流
tags:
- workflow
securityDefinitions:
ApiKeyAuth:
in: header
name: x-token
type: apiKey
swagger: "2.0"
|
