mirror of
https://github.com/go-admin-team/go-admin.git
synced 2026-09-21 10:13:01 +00:00
1636 lines
37 KiB
YAML
1636 lines
37 KiB
YAML
definitions:
|
||
dto.PassWord:
|
||
properties:
|
||
newPassword:
|
||
type: string
|
||
oldPassword:
|
||
type: string
|
||
required:
|
||
- newPassword
|
||
- oldPassword
|
||
type: object
|
||
dto.SysDeptById:
|
||
properties:
|
||
id:
|
||
type: integer
|
||
ids:
|
||
items:
|
||
type: integer
|
||
type: array
|
||
type: object
|
||
dto.SysDeptControl:
|
||
properties:
|
||
deptId:
|
||
description: 编码
|
||
type: integer
|
||
deptName:
|
||
description: 部门名称
|
||
type: string
|
||
deptPath:
|
||
description: 路径
|
||
type: string
|
||
email:
|
||
description: 邮箱
|
||
type: string
|
||
leader:
|
||
description: 负责人
|
||
type: string
|
||
parentId:
|
||
description: 上级部门
|
||
type: integer
|
||
phone:
|
||
description: 手机
|
||
type: string
|
||
sort:
|
||
description: 排序
|
||
type: integer
|
||
status:
|
||
description: 状态
|
||
type: string
|
||
type: object
|
||
dto.SysDictDataControl:
|
||
properties:
|
||
cssClass:
|
||
type: string
|
||
default:
|
||
type: string
|
||
dictLabel:
|
||
type: string
|
||
dictSort:
|
||
type: integer
|
||
dictType:
|
||
type: string
|
||
dictValue:
|
||
type: string
|
||
id:
|
||
type: integer
|
||
isDefault:
|
||
type: string
|
||
listClass:
|
||
type: string
|
||
remark:
|
||
type: string
|
||
status:
|
||
type: string
|
||
type: object
|
||
dto.SysDictTypeControl:
|
||
properties:
|
||
dictName:
|
||
type: string
|
||
dictType:
|
||
type: string
|
||
id:
|
||
type: integer
|
||
remark:
|
||
type: string
|
||
status:
|
||
type: string
|
||
type: object
|
||
dto.SysMenuById:
|
||
properties:
|
||
id:
|
||
type: integer
|
||
ids:
|
||
items:
|
||
type: integer
|
||
type: array
|
||
type: object
|
||
dto.SysMenuControl:
|
||
properties:
|
||
action:
|
||
description: 请求方式
|
||
type: string
|
||
breadcrumb:
|
||
description: 是否面包屑
|
||
type: string
|
||
component:
|
||
description: 组件
|
||
type: string
|
||
icon:
|
||
description: 图标
|
||
type: string
|
||
isFrame:
|
||
description: 是否frame
|
||
type: string
|
||
menuId:
|
||
description: 编码
|
||
type: integer
|
||
menuName:
|
||
description: 菜单name
|
||
type: string
|
||
menuType:
|
||
description: 菜单类型
|
||
type: string
|
||
noCache:
|
||
description: 是否缓存
|
||
type: boolean
|
||
parentId:
|
||
description: 上级菜单
|
||
type: integer
|
||
path:
|
||
description: 路径
|
||
type: string
|
||
paths:
|
||
description: id路径
|
||
type: string
|
||
permission:
|
||
description: 权限编码
|
||
type: string
|
||
sort:
|
||
description: 排序
|
||
type: integer
|
||
title:
|
||
description: 显示名称
|
||
type: string
|
||
visible:
|
||
description: 是否显示
|
||
type: string
|
||
type: object
|
||
dto.SysPostControl:
|
||
properties:
|
||
postCode:
|
||
description: 编码
|
||
type: string
|
||
postId:
|
||
description: id
|
||
type: integer
|
||
postName:
|
||
description: 名称
|
||
type: string
|
||
remark:
|
||
description: 备注
|
||
type: string
|
||
sort:
|
||
description: 排序
|
||
type: integer
|
||
status:
|
||
description: 状态
|
||
type: integer
|
||
type: object
|
||
dto.SysRoleById:
|
||
properties:
|
||
id:
|
||
type: integer
|
||
ids:
|
||
items:
|
||
type: integer
|
||
type: array
|
||
type: object
|
||
dto.SysRoleControl:
|
||
properties:
|
||
admin:
|
||
type: boolean
|
||
dataScope:
|
||
type: string
|
||
flag:
|
||
description: 标记
|
||
type: string
|
||
menuIds:
|
||
items:
|
||
type: integer
|
||
type: array
|
||
remark:
|
||
description: 备注
|
||
type: string
|
||
roleId:
|
||
description: 角色编码
|
||
type: integer
|
||
roleKey:
|
||
description: 角色代码
|
||
type: string
|
||
roleName:
|
||
description: 角色名称
|
||
type: string
|
||
roleSort:
|
||
description: 角色排序
|
||
type: integer
|
||
status:
|
||
description: 状态
|
||
type: string
|
||
type: object
|
||
dto.SysSettingControl:
|
||
properties:
|
||
logo:
|
||
description: 头像
|
||
type: string
|
||
name:
|
||
description: 名称
|
||
type: string
|
||
settings_id:
|
||
description: 头像
|
||
type: integer
|
||
required:
|
||
- logo
|
||
- name
|
||
- settings_id
|
||
type: object
|
||
dto.SysUserControl:
|
||
properties:
|
||
avatar:
|
||
type: string
|
||
deptId:
|
||
type: integer
|
||
email:
|
||
type: string
|
||
nickName:
|
||
type: string
|
||
password:
|
||
type: string
|
||
phone:
|
||
type: string
|
||
postId:
|
||
type: integer
|
||
remark:
|
||
type: string
|
||
roleId:
|
||
type: integer
|
||
sex:
|
||
type: string
|
||
status:
|
||
type: string
|
||
userId:
|
||
description: 用户ID
|
||
type: integer
|
||
username:
|
||
type: string
|
||
type: object
|
||
handler.Login:
|
||
properties:
|
||
code:
|
||
type: string
|
||
password:
|
||
type: string
|
||
username:
|
||
type: string
|
||
uuid:
|
||
type: string
|
||
required:
|
||
- code
|
||
- password
|
||
- username
|
||
- uuid
|
||
type: object
|
||
response.Response:
|
||
properties:
|
||
code:
|
||
type: integer
|
||
msg:
|
||
type: string
|
||
requestId:
|
||
type: string
|
||
status:
|
||
type: string
|
||
type: object
|
||
tools.Params:
|
||
properties:
|
||
treeCode:
|
||
type: string
|
||
treeName:
|
||
type: string
|
||
treeParentCode:
|
||
type: string
|
||
type: object
|
||
tools.SysColumns:
|
||
properties:
|
||
columnComment:
|
||
type: string
|
||
columnId:
|
||
type: integer
|
||
columnName:
|
||
type: string
|
||
columnType:
|
||
type: string
|
||
createBy:
|
||
type: string
|
||
createdAt:
|
||
type: string
|
||
deletedAt:
|
||
type: string
|
||
dictType:
|
||
type: string
|
||
edit:
|
||
type: boolean
|
||
fkCol:
|
||
items:
|
||
$ref: '#/definitions/tools.SysColumns'
|
||
type: array
|
||
fkLabelId:
|
||
type: string
|
||
fkLabelName:
|
||
type: string
|
||
fkTableName:
|
||
type: string
|
||
fkTableNameClass:
|
||
type: string
|
||
fkTableNamePackage:
|
||
type: string
|
||
goField:
|
||
type: string
|
||
goType:
|
||
type: string
|
||
htmlType:
|
||
type: string
|
||
increment:
|
||
type: boolean
|
||
insert:
|
||
type: boolean
|
||
isEdit:
|
||
type: string
|
||
isIncrement:
|
||
type: string
|
||
isInsert:
|
||
type: string
|
||
isList:
|
||
type: string
|
||
isPk:
|
||
type: string
|
||
isQuery:
|
||
type: string
|
||
isRequired:
|
||
type: string
|
||
jsonField:
|
||
type: string
|
||
list:
|
||
type: string
|
||
pk:
|
||
type: boolean
|
||
query:
|
||
type: boolean
|
||
queryType:
|
||
type: string
|
||
remark:
|
||
type: string
|
||
required:
|
||
type: boolean
|
||
sort:
|
||
type: integer
|
||
superColumn:
|
||
type: boolean
|
||
tableId:
|
||
type: integer
|
||
updateBy:
|
||
type: string
|
||
updatedAt:
|
||
type: string
|
||
usableColumn:
|
||
type: boolean
|
||
type: object
|
||
tools.SysTables:
|
||
properties:
|
||
businessName:
|
||
type: string
|
||
className:
|
||
description: 类名
|
||
type: string
|
||
columns:
|
||
items:
|
||
$ref: '#/definitions/tools.SysColumns'
|
||
type: array
|
||
createBy:
|
||
type: string
|
||
createdAt:
|
||
type: string
|
||
crud:
|
||
type: boolean
|
||
dataScope:
|
||
type: string
|
||
deletedAt:
|
||
type: string
|
||
functionAuthor:
|
||
description: 功能作者
|
||
type: string
|
||
functionName:
|
||
description: 功能名称
|
||
type: string
|
||
isActions:
|
||
type: integer
|
||
isAuth:
|
||
type: integer
|
||
isDataScope:
|
||
type: integer
|
||
isLogicalDelete:
|
||
type: string
|
||
logicalDelete:
|
||
type: boolean
|
||
logicalDeleteColumn:
|
||
type: string
|
||
moduleName:
|
||
description: 模块名
|
||
type: string
|
||
options:
|
||
type: string
|
||
packageName:
|
||
description: 包名
|
||
type: string
|
||
params:
|
||
$ref: '#/definitions/tools.Params'
|
||
pkColumn:
|
||
type: string
|
||
pkGoField:
|
||
type: string
|
||
pkJsonField:
|
||
type: string
|
||
remark:
|
||
type: string
|
||
tableComment:
|
||
description: 表备注
|
||
type: string
|
||
tableId:
|
||
description: 表编码
|
||
type: integer
|
||
tableName:
|
||
description: 表名称
|
||
type: string
|
||
tplCategory:
|
||
type: string
|
||
tree:
|
||
type: boolean
|
||
treeCode:
|
||
type: string
|
||
treeName:
|
||
type: string
|
||
treeParentCode:
|
||
type: string
|
||
updateBy:
|
||
type: string
|
||
updatedAt:
|
||
type: string
|
||
type: object
|
||
info:
|
||
contact: {}
|
||
description: |-
|
||
基于Gin + Vue + Element UI的前后端分离权限管理系统的接口文档
|
||
添加qq群: 74520518 进入技术交流群 请备注，谢谢！
|
||
license:
|
||
name: MIT
|
||
url: https://github.com/go-admin-team/go-admin/blob/master/LICENSE.md
|
||
title: go-admin API
|
||
version: 1.3.1
|
||
paths:
|
||
/api/v1/db/columns/page:
|
||
get:
|
||
description: 数据库表列分页列表 / database table column page list
|
||
parameters:
|
||
- description: tableName / 数据表名称
|
||
in: query
|
||
name: tableName
|
||
type: string
|
||
- description: pageSize / 页条数
|
||
in: query
|
||
name: pageSize
|
||
type: integer
|
||
- description: pageIndex / 页码
|
||
in: query
|
||
name: pageIndex
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
summary: 分页列表数据 / page list data
|
||
tags:
|
||
- 工具 / Tools
|
||
/api/v1/db/tables/page:
|
||
get:
|
||
description: 数据库表分页列表 / database table page list
|
||
parameters:
|
||
- description: tableName / 数据表名称
|
||
in: query
|
||
name: tableName
|
||
type: string
|
||
- description: pageSize / 页条数
|
||
in: query
|
||
name: pageSize
|
||
type: integer
|
||
- description: pageIndex / 页码
|
||
in: query
|
||
name: pageIndex
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
summary: 分页列表数据 / page list data
|
||
tags:
|
||
- 工具 / Tools
|
||
/api/v1/dept:
|
||
delete:
|
||
description: 删除数据
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysDeptById'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 删除部门
|
||
tags:
|
||
- 部门
|
||
get:
|
||
description: 分页列表
|
||
parameters:
|
||
- description: name
|
||
in: query
|
||
name: name
|
||
type: string
|
||
- description: id
|
||
in: query
|
||
name: id
|
||
type: string
|
||
- description: position
|
||
in: query
|
||
name: position
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 分页部门列表数据
|
||
tags:
|
||
- 部门
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: data
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysDeptControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 添加部门
|
||
tags:
|
||
- 部门
|
||
/api/v1/dept/{deptId}:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: deptId
|
||
in: path
|
||
name: deptId
|
||
type: string
|
||
- description: position
|
||
in: query
|
||
name: position
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 部门列表数据
|
||
tags:
|
||
- 部门
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysDeptControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 修改部门
|
||
tags:
|
||
- 部门
|
||
/api/v1/dict/data:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: status
|
||
in: query
|
||
name: status
|
||
type: string
|
||
- description: dictCode
|
||
in: query
|
||
name: dictCode
|
||
type: string
|
||
- description: dictType
|
||
in: query
|
||
name: dictType
|
||
type: string
|
||
- description: 页条数
|
||
in: query
|
||
name: pageSize
|
||
type: integer
|
||
- description: 页码
|
||
in: query
|
||
name: pageIndex
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 字典数据列表
|
||
tags:
|
||
- 字典数据
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: data
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysDictDataControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 添加字典数据
|
||
tags:
|
||
- 字典数据
|
||
/api/v1/dict/data/{dictCode}:
|
||
delete:
|
||
description: 删除数据
|
||
parameters:
|
||
- description: dictCode
|
||
in: path
|
||
name: dictCode
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 删除字典数据
|
||
tags:
|
||
- 字典数据
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: 字典编码
|
||
in: path
|
||
name: dictCode
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 通过编码获取字典数据
|
||
tags:
|
||
- 字典数据
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysDictDataControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 修改字典数据
|
||
tags:
|
||
- 字典数据
|
||
/api/v1/dict/type:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: dictName
|
||
in: query
|
||
name: dictName
|
||
type: string
|
||
- description: dictId
|
||
in: query
|
||
name: dictId
|
||
type: string
|
||
- description: dictType
|
||
in: query
|
||
name: dictType
|
||
type: string
|
||
- description: 页条数
|
||
in: query
|
||
name: pageSize
|
||
type: integer
|
||
- description: 页码
|
||
in: query
|
||
name: pageIndex
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 字典类型列表数据
|
||
tags:
|
||
- 字典类型
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: data
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysDictTypeControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 添加字典类型
|
||
tags:
|
||
- 字典类型
|
||
/api/v1/dict/type-option-select:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: dictName
|
||
in: query
|
||
name: dictName
|
||
type: string
|
||
- description: dictId
|
||
in: query
|
||
name: dictId
|
||
type: string
|
||
- description: dictType
|
||
in: query
|
||
name: dictType
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 字典类型全部数据
|
||
tags:
|
||
- 字典类型
|
||
/api/v1/dict/type/{dictId}:
|
||
delete:
|
||
description: 删除数据
|
||
parameters:
|
||
- description: dictId
|
||
in: path
|
||
name: dictId
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 删除字典类型
|
||
tags:
|
||
- 字典类型
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: 字典类型编码
|
||
in: path
|
||
name: dictId
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 通过字典id获取字典类型
|
||
tags:
|
||
- 字典类型
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysDictTypeControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 修改字典类型
|
||
tags:
|
||
- 字典类型
|
||
/api/v1/menu:
|
||
post:
|
||
consumes:
|
||
- application/x-www-form-urlencoded
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: menuName
|
||
in: formData
|
||
name: menuName
|
||
required: true
|
||
type: string
|
||
- description: Path
|
||
in: formData
|
||
name: Path
|
||
type: string
|
||
- description: Action
|
||
in: formData
|
||
name: Action
|
||
required: true
|
||
type: string
|
||
- description: Permission
|
||
in: formData
|
||
name: Permission
|
||
required: true
|
||
type: string
|
||
- description: ParentId
|
||
in: formData
|
||
name: ParentId
|
||
required: true
|
||
type: string
|
||
- description: IsDel
|
||
in: formData
|
||
name: IsDel
|
||
required: true
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 创建菜单
|
||
tags:
|
||
- 菜单
|
||
/api/v1/menu/:
|
||
delete:
|
||
description: 删除数据
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysMenuById'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 删除菜单
|
||
tags:
|
||
- 菜单
|
||
/api/v1/menu/{id}:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: menuName
|
||
in: query
|
||
name: menuName
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "抱歉未找到相关信息"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: Menu详情数据
|
||
tags:
|
||
- 菜单
|
||
put:
|
||
consumes:
|
||
- application/x-www-form-urlencoded
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysMenuControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "修改失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 修改菜单
|
||
tags:
|
||
- 菜单
|
||
/api/v1/menuTreeselect:
|
||
get:
|
||
consumes:
|
||
- application/x-www-form-urlencoded
|
||
description: 获取JSON
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 获取菜单树
|
||
tags:
|
||
- 菜单
|
||
/api/v1/menuids/{id}:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "抱歉未找到相关信息"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 获取角色对应的菜单id数组
|
||
tags:
|
||
- 菜单
|
||
/api/v1/menulist:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: menuName
|
||
in: query
|
||
name: menuName
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "抱歉未找到相关信息"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: Menu列表数据
|
||
tags:
|
||
- 菜单
|
||
/api/v1/menurole:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "抱歉未找到相关信息"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 根据角色名称获取菜单列表数据（左菜单使用）
|
||
tags:
|
||
- 菜单
|
||
/api/v1/post:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: postName
|
||
in: query
|
||
name: postName
|
||
type: string
|
||
- description: postCode
|
||
in: query
|
||
name: postCode
|
||
type: string
|
||
- description: postId
|
||
in: query
|
||
name: postId
|
||
type: string
|
||
- description: status
|
||
in: query
|
||
name: status
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 岗位列表数据
|
||
tags:
|
||
- 岗位
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: data
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysPostControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 添加岗位
|
||
tags:
|
||
- 岗位
|
||
/api/v1/post/:
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysPostControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 修改岗位
|
||
tags:
|
||
- 岗位
|
||
/api/v1/post/{postId}:
|
||
delete:
|
||
description: 删除数据
|
||
parameters:
|
||
- description: id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "message": "删除成功"}'
|
||
schema:
|
||
type: string
|
||
"500":
|
||
description: '{"code": 500, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 删除岗位
|
||
tags:
|
||
- 岗位
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: postId
|
||
in: path
|
||
name: postId
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 获取岗位信息
|
||
tags:
|
||
- 岗位
|
||
/api/v1/public/uploadFile:
|
||
post:
|
||
consumes:
|
||
- multipart/form-data
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: type
|
||
in: query
|
||
name: type
|
||
required: true
|
||
type: string
|
||
- description: file
|
||
in: formData
|
||
name: file
|
||
required: true
|
||
type: file
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 上传图片
|
||
tags:
|
||
- 公共接口
|
||
/api/v1/role:
|
||
delete:
|
||
description: 删除数据
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysRoleById'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 删除用户角色
|
||
tags:
|
||
- 角色/Role
|
||
get:
|
||
description: Get JSON
|
||
parameters:
|
||
- description: roleName
|
||
in: query
|
||
name: roleName
|
||
type: string
|
||
- description: status
|
||
in: query
|
||
name: status
|
||
type: string
|
||
- description: roleKey
|
||
in: query
|
||
name: roleKey
|
||
type: string
|
||
- description: 页条数
|
||
in: query
|
||
name: pageSize
|
||
type: integer
|
||
- description: 页码
|
||
in: query
|
||
name: pageIndex
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 角色列表数据
|
||
tags:
|
||
- 角色/Role
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: data
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysRoleControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 创建角色
|
||
tags:
|
||
- 角色/Role
|
||
/api/v1/role/{id}:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: roleId
|
||
in: path
|
||
name: roleId
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "抱歉未找到相关信息"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 获取Role数据
|
||
tags:
|
||
- 角色/Role
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysRoleControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "修改失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 修改用户角色
|
||
tags:
|
||
- 角色/Role
|
||
/api/v1/setting:
|
||
get:
|
||
description: 获取JSON
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 查询系统信息
|
||
tags:
|
||
- 系统信息
|
||
/api/v1/settings/serverInfo:
|
||
get:
|
||
description: 获取JSON
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
summary: 系统信息
|
||
tags:
|
||
- 系统信息
|
||
/api/v1/sys/tables/info:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 添加表结构
|
||
parameters:
|
||
- description: tableName / 数据表名称
|
||
in: query
|
||
name: tables
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 添加表结构
|
||
tags:
|
||
- 工具 - 生成表
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 修改表结构
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/tools.SysTables'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 修改表结构
|
||
tags:
|
||
- 工具 - 生成表
|
||
/api/v1/sys/tables/info/{tableId}:
|
||
delete:
|
||
description: 删除表结构
|
||
parameters:
|
||
- description: tableId
|
||
in: path
|
||
name: tableId
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 删除表结构
|
||
tags:
|
||
- 工具 - 生成表
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: configKey
|
||
in: path
|
||
name: configKey
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 获取配置
|
||
tags:
|
||
- 工具 - 生成表
|
||
/api/v1/sys/tables/page:
|
||
get:
|
||
description: 生成表分页列表
|
||
parameters:
|
||
- description: tableName / 数据表名称
|
||
in: query
|
||
name: tableName
|
||
type: string
|
||
- description: pageSize / 页条数
|
||
in: query
|
||
name: pageSize
|
||
type: integer
|
||
- description: pageIndex / 页码
|
||
in: query
|
||
name: pageIndex
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
summary: 分页列表数据
|
||
tags:
|
||
- 工具 - 生成表
|
||
/api/v1/sysUser:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: username
|
||
in: query
|
||
name: username
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "抱歉未找到相关信息"}'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 列表用户信息数据
|
||
tags:
|
||
- 用户
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: 用户数据
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysUserControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 创建用户
|
||
tags:
|
||
- 用户
|
||
/api/v1/sysUser/{userId}:
|
||
get:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: 用户编码
|
||
in: path
|
||
name: userId
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 获取用户
|
||
tags:
|
||
- 用户
|
||
/api/v1/system/setting:
|
||
post:
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysSettingControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 更新或提交系统信息
|
||
tags:
|
||
- 系统信息
|
||
/api/v1/sysuser/{userId}:
|
||
delete:
|
||
description: 删除数据
|
||
parameters:
|
||
- description: userId
|
||
in: path
|
||
name: userId
|
||
required: true
|
||
type: integer
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "删除失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 删除用户数据
|
||
tags:
|
||
- 用户
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SysUserControl'
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "修改失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 修改用户数据
|
||
tags:
|
||
- 用户
|
||
/api/v1/user/avatar:
|
||
post:
|
||
consumes:
|
||
- multipart/form-data
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: file
|
||
in: formData
|
||
name: file
|
||
required: true
|
||
type: file
|
||
responses:
|
||
"200":
|
||
description: '{"code": -1, "message": "添加失败"}'
|
||
schema:
|
||
type: string
|
||
summary: 修改头像
|
||
tags:
|
||
- 用户
|
||
/api/v1/user/profile:
|
||
get:
|
||
description: 获取JSON
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 获取个人中心用户
|
||
tags:
|
||
- 个人中心
|
||
/api/v1/user/pwd:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取JSON
|
||
parameters:
|
||
- description: body
|
||
in: body
|
||
name: data
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.PassWord'
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "data": [...]}'
|
||
schema:
|
||
$ref: '#/definitions/response.Response'
|
||
security:
|
||
- Bearer: []
|
||
summary: 重置密码
|
||
tags:
|
||
- 用户
|
||
/login:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: |-
|
||
获取token
|
||
LoginHandler can be used by clients to get a jwt token.
|
||
Payload needs to be json in the form of {"username": "USERNAME", "password": "PASSWORD"}.
|
||
Reply will be of the form {"token": "TOKEN"}.
|
||
dev mode：It should be noted that all fields cannot be empty, and a value of 0 can be passed in addition to the account password
|
||
注意：开发模式：需要注意全部字段不能为空，账号密码外可以传入0值
|
||
parameters:
|
||
- description: account
|
||
in: body
|
||
name: account
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/handler.Login'
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "expire": "2019-08-07T12:45:48+08:00", "token":
|
||
".eyJleHAiOjE1NjUxNTMxNDgsImlkIjoiYWRtaW4iLCJvcmlnX2lhdCI6MTU2NTE0OTU0OH0.-zvzHvbg0A"
|
||
}'
|
||
schema:
|
||
type: string
|
||
summary: 登陆
|
||
/logout:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取token
|
||
responses:
|
||
"200":
|
||
description: '{"code": 200, "msg": "成功退出系统" }'
|
||
schema:
|
||
type: string
|
||
security:
|
||
- Bearer: []
|
||
summary: 退出登录
|
||
securityDefinitions:
|
||
Bearer:
|
||
in: header
|
||
name: Authorization
|
||
type: apiKey
|
||
swagger: "2.0"
|