You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

849 lines
19 KiB

basePath: /
definitions:
api.AddMenuAuthorityInfo:
properties:
authorityId:
type: string
menus:
items:
$ref: '#/definitions/dbModel.BaseMenu'
type: array
type: object
api.AuthAndPathIn:
properties:
apiIds:
items:
type: integer
type: array
authorityId:
type: string
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.CreateAuthorityPatams:
properties:
authorityId:
type: string
authorityName:
type: string
type: object
api.DeleteAuthorityPatams:
properties:
authorityId:
type: integer
type: object
api.GetAuthorityId:
properties:
authorityId:
type: string
type: object
api.GetById:
properties:
id:
type: number
type: object
api.IdInfo:
properties:
id:
type: number
type: object
api.RegistAndLoginStuct:
properties:
password:
type: string
username:
type: string
type: object
api.SetUserAuth:
properties:
authorityId:
type: string
uuid:
type: string
type: object
dbModel.Api:
properties:
description:
type: string
group:
type: string
path:
type: string
type: object
dbModel.BaseMenu:
properties:
children:
items:
$ref: '#/definitions/dbModel.BaseMenu'
type: array
component:
type: string
hidden:
type: boolean
icon:
type: string
name:
type: string
nickName:
type: string
parentId:
type: string
path:
type: string
title:
type: string
type: object
dbModel.FileUploadAndDownload:
properties:
key:
type: string
name:
type: string
tag:
type: string
url:
type: string
type: object
dbModel.Workflow:
properties:
workflowDescription:
description: 工作流描述
type: string
workflowName:
description: 工作流英文id
type: string
workflowNickName:
description: 工作流名称
type: string
workflowStep:
description: 工作流步骤
items:
$ref: '#/definitions/dbModel.WorkflowStepInfo'
type: array
type: object
dbModel.WorkflowStepInfo:
properties:
isEnd:
description: 是否是完结流节点
type: boolean
isStrat:
description: 是否是开始流节点
type: boolean
stepAuthorityID:
description: 操作者级别id
type: string
stepName:
description: 工作流名称
type: string
stepNo:
description: 步骤id (第几步)
type: number
type: object
modelInterface.PageInfo:
properties:
page:
type: integer
pageSize:
type: integer
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:
- Api
/api/deleteApi:
post:
consumes:
- application/json
parameters:
- description: 删除api
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.Api'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除指定api
tags:
- Api
/api/getAllApis:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取所有的Api 不分页
tags:
- Api
/api/getApiById:
post:
consumes:
- application/json
parameters:
- description: 分页获取用户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/modelInterface.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 根据id获取api
tags:
- Api
/api/getApiList:
post:
consumes:
- application/json
parameters:
- description: 分页获取API列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/modelInterface.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取API列表
tags:
- Api
/api/setAuthAndApi:
post:
consumes:
- application/json
parameters:
- description: 创建api和角色关系
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.AuthAndPathIn'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 创建api和角色关系
tags:
- Api
/api/updataApi:
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:
- Api
/authority/createAuthority:
post:
consumes:
- application/json
parameters:
- description: 创建角色
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateAuthorityPatams'
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/getAuthAndApi:
post:
consumes:
- application/json
parameters:
- description: 获取本角色所有有权限的apiId
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.GetAuthorityId'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取本角色所有有权限的apiId
tags:
- authority
/authority/getAuthorityList:
post:
consumes:
- application/json
parameters:
- description: 分页获取用户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/modelInterface.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取角色列表
tags:
- authority
/base/login:
post:
parameters:
- description: 用户登录接口
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.RegistAndLoginStuct'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"登陆成功"}'
schema:
type: string
summary: 用户登录
tags:
- Base
/base/regist:
post:
parameters:
- description: 用户注册接口
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.RegistAndLoginStuct'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"注册成功"}'
schema:
type: string
summary: 用户注册账号
tags:
- Base
/fileUploadAndDownload/deleteFile:
post:
parameters:
- description: 传入文件里面id即可
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.FileUploadAndDownload'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"返回成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除文件
tags:
- FileUploadAndDownload
/fileUploadAndDownload/getFileList:
post:
consumes:
- application/json
parameters:
- description: 分页获取文件户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/modelInterface.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页文件列表
tags:
- FileUploadAndDownload
/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:
- FileUploadAndDownload
/menu/addBaseMenu:
post:
consumes:
- application/json
parameters:
- description: 新增菜单
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.BaseMenu'
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.RegistAndLoginStuct'
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.RegistAndLoginStuct'
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/modelInterface.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取基础menu列表
tags:
- menu
/menu/updataBaseMen:
post:
consumes:
- application/json
parameters:
- description: 更新菜单
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.BaseMenu'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 更新菜单
tags:
- menu
/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:
- User
/user/getUserList:
post:
consumes:
- application/json
parameters:
- description: 分页获取用户列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/modelInterface.PageInfo'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分页获取用户列表
tags:
- User
/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:
- User
/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:
- User
/workflow/createWorkFlow:
post:
parameters:
- description: 注册工作流接口
in: body
name: data
required: true
schema:
$ref: '#/definitions/dbModel.Workflow'
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"