mh_goadmin_server/docs/swagger.yaml
2023-10-19 11:36:28 +08:00

2841 lines
63 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

definitions:
app.Page:
properties:
count:
type: integer
list: {}
pageIndex:
type: integer
pageSize:
type: integer
type: object
app.Response:
properties:
code:
description: 代码
example: 200
type: integer
data:
description: 数据集
msg:
description: 消息
type: string
requestId:
type: string
type: object
basic.CategoryDisplayRequest:
properties:
display:
description: 是否展示 1展示 0隐藏
type: integer
id:
description: 分类id
type: integer
type: object
basic.CategoryListRequest:
properties:
is_all:
description: 是否展示全部
type: boolean
type: object
basic.CreateCategoryRequest:
properties:
name:
description: 名称
type: string
pid:
description: 父分类id
type: integer
required:
- name
type: object
basic.SupplierCreateRequest:
properties:
account_holder:
description: 开户人
type: string
address:
description: 地址
type: string
area:
description: 地区
type: string
bank_account:
description: 银行卡号
type: string
city:
description: 城市
type: string
company_website:
description: 网站
type: string
contact:
description: 联系人
type: string
email:
description: 邮箱
type: string
landline:
description: 固话
type: string
name:
description: 供应商名称
type: string
opening_bank:
description: 开户行
type: string
payment_cycle:
description: 支付周期
type: integer
province:
description: 省份
type: string
tax_number:
description: 税点
type: string
tel:
description: 手机号
type: string
required:
- address
- area
- bank_account
- city
- contact
- name
- opening_bank
- payment_cycle
- province
- tel
type: object
basic.SupplierListRequest:
properties:
name:
description: 供应商名称
type: string
number:
description: 供应商编号
type: string
type: object
basic.SupplierUpdateRequest:
properties:
account_holder:
description: 开户人
type: string
address:
description: 地址
type: string
area:
description: 地区
type: string
bank_account:
description: 银行卡号
type: string
city:
description: 城市
type: string
company_website:
description: 网站
type: string
contact:
description: 联系人
type: string
email:
description: 邮箱
type: string
id:
type: integer
landline:
description: 固话
type: string
name:
description: 供应商名称
type: string
opening_bank:
description: 开户行
type: string
payment_cycle:
description: 支付周期
type: integer
province:
description: 省份
type: string
tax_number:
description: 税点
type: string
tel:
description: 手机号
type: string
required:
- address
- area
- bank_account
- city
- contact
- id
- name
- opening_bank
- payment_cycle
- province
- tel
type: object
basic.UpdateCategoryRequest:
properties:
id:
description: 分类id
type: integer
name:
description: 名称
type: string
pid:
description: 父分类id
type: integer
required:
- id
- name
type: object
models.Category:
properties:
cooperative_business_id:
description: 合作商id
type: integer
createdAt:
type: string
display:
description: 1 展示 0 隐藏
type: integer
id:
type: integer
name:
description: 分类名称
type: string
number:
description: 编号
type: string
pid:
description: 父分类的编号
type: integer
type: object
models.CategoryModel:
properties:
cooperative_business_id:
description: 合作商id
type: integer
createdAt:
type: string
display:
description: 1 展示 0 隐藏
type: integer
id:
type: integer
name:
description: 分类名称
type: string
number:
description: 编号
type: string
pid:
description: 父分类的编号
type: integer
subCategory:
items:
$ref: '#/definitions/models.CategoryModel'
type: array
type: object
models.DictType:
properties:
createBy:
description: 创建者
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
dictId:
type: integer
dictName:
description: 字典名称
type: string
dictType:
description: 字典类型
type: string
params:
type: string
remark:
description: 备注
type: string
status:
description: 状态
type: string
updateBy:
description: 更新者
type: string
updatedAt:
type: string
type: object
models.Login:
properties:
code:
type: string
password:
type: string
sys_type:
description: 1-管理系统 2-合作商系统
type: integer
username:
type: string
uuid:
type: string
required:
- code
- password
- sys_type
- username
- uuid
type: object
models.LoginLog:
properties:
browser:
description: 浏览器
type: string
createBy:
description: 创建人
type: string
createdAt:
type: string
dataScope:
description: 数据
type: string
deletedAt:
type: string
infoId:
description: 主键
type: integer
ipaddr:
description: ip地址
type: string
loginLocation:
description: 归属地
type: string
loginTime:
description: 登录时间
type: string
msg:
type: string
os:
description: 系统
type: string
params:
type: string
platform:
description: 固件
type: string
remark:
description: 备注
type: string
status:
description: 状态
type: string
updateBy:
description: 更新者
type: string
updatedAt:
type: string
username:
description: 用户名
type: string
type: object
models.Menu:
properties:
action:
type: string
breadcrumb:
type: string
children:
items:
$ref: '#/definitions/models.Menu'
type: array
component:
type: string
createBy:
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
icon:
type: string
is_select:
type: boolean
isFrame:
type: string
menuId:
type: integer
menuName:
type: string
menuType:
type: string
noCache:
type: boolean
params:
type: string
parentId:
type: integer
path:
type: string
paths:
type: string
permission:
type: string
roleId:
type: integer
sort:
type: integer
title:
type: string
updateBy:
type: string
updatedAt:
type: string
visible:
type: string
type: object
models.Post:
properties:
createBy:
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
params:
type: string
postCode:
description: 岗位代码
type: string
postId:
description: 岗位编号
type: integer
postName:
description: 岗位名称
type: string
remark:
description: 描述
type: string
sort:
description: 岗位排序
type: integer
status:
description: 状态
type: string
updateBy:
type: string
updatedAt:
type: string
type: object
models.Supplier:
properties:
account_holder:
description: 开户人
type: string
address:
description: 详细地址
type: string
area:
description:
type: string
bank_account:
description: 银行账号
type: string
city:
description:
type: string
company_website:
description: 网站
type: string
contact:
description: 联系人
type: string
cooperative_business_id:
description: 合作商id
type: integer
createdAt:
type: string
email:
description: 邮件
type: string
id:
type: integer
landline:
description: 固定电话
type: string
name:
description: 供应商名称
type: string
number:
description: 编号
type: string
opening_bank:
description: 开户银行
type: string
payment_cycle:
description: 支付周期
type: integer
province:
description:
type: string
tax_number:
description: 税号
type: string
tel:
description: 手机号
type: string
type: object
models.SysCategory:
properties:
createBy:
description: 创建者
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
id:
description: 分类Id
type: integer
img:
description: 图片
type: string
name:
description: 名称
type: string
params:
type: string
remark:
description: 备注
type: string
sort:
description: 排序
type: string
status:
description: 状态
type: string
updateBy:
description: 更新者
type: string
updatedAt:
type: string
type: object
models.SysConfig:
properties:
configId:
description: 编码
type: integer
configKey:
description: 参数键名
type: string
configName:
description: 参数名称
type: string
configType:
description: 是否系统内置
type: string
configValue:
description: 参数键值
type: string
createBy:
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
params:
type: string
remark:
description: 备注
type: string
updateBy:
type: string
updatedAt:
type: string
type: object
models.SysContent:
properties:
cateId:
description: 分类id
type: string
content:
description: 内容
type: string
createBy:
description: 创建者
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
id:
description: id
type: integer
img:
description: 图片
type: string
name:
description: 名称
type: string
params:
type: string
remark:
description: 备注
type: string
sort:
description: 排序
type: string
status:
description: 状态
type: string
updateBy:
description: 更新者
type: string
updatedAt:
type: string
type: object
models.SysDept:
properties:
children:
items:
$ref: '#/definitions/models.SysDept'
type: array
createBy:
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
deptId:
description: 部门编码
type: integer
deptName:
description: 部门名称
type: string
deptPath:
type: string
email:
description: 邮箱
type: string
leader:
description: 负责人
type: string
params:
type: string
parentId:
description: 上级部门
type: integer
phone:
description: 手机
type: string
sort:
description: 排序
type: integer
status:
description: 状态
type: string
updateBy:
type: string
updatedAt:
type: string
type: object
models.SysFileDir:
properties:
children:
items:
$ref: '#/definitions/models.SysFileDir'
type: array
createBy:
description: 创建人
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
id:
type: integer
label:
description: 名称
type: string
pId:
description: 父id
type: integer
params:
type: string
path:
type: string
sort:
description: 排序
type: integer
updateBy:
description: 编辑人
type: string
updatedAt:
type: string
type: object
models.SysOperLog:
properties:
businessType:
description: 操作类型
type: string
businessTypes:
type: string
createBy:
description: 创建人
type: string
createdAt:
type: string
dataScope:
description: 数据
type: string
deletedAt:
type: string
deptName:
description: 部门名称
type: string
jsonResult:
description: 返回数据
type: string
latencyime:
description: 耗时
type: string
method:
description: 函数
type: string
operId:
description: 日志编码
type: integer
operIp:
description: 客户端ip
type: string
operLocation:
description: 访问位置
type: string
operName:
description: 操作者
type: string
operParam:
description: 请求参数
type: string
operTime:
description: 操作时间
type: string
operUrl:
description: 访问地址
type: string
operatorType:
description: 操作类型
type: string
params:
description: 参数
type: string
remark:
description: 备注
type: string
requestMethod:
description: 请求方式
type: string
status:
description: 操作状态
type: string
title:
description: 操作模块
type: string
updateBy:
description: 更新者
type: string
updatedAt:
type: string
userAgent:
description: ua
type: string
type: object
models.SysRole:
properties:
admin:
type: boolean
createBy:
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
deptIds:
items:
type: integer
type: array
flag:
type: string
menuIds:
items:
type: integer
type: array
params:
type: string
remark:
description: 备注
type: string
roleId:
description: 角色编码
type: integer
roleKey:
description: 角色代码
type: string
roleName:
description: 角色名称
type: string
roleSort:
description: 角色排序
type: integer
status:
type: string
updateBy:
type: string
updatedAt:
type: string
type: object
models.SysUser:
properties:
account_type:
description: 账号类型:1-管理端
type: integer
avatar:
description: 头像
type: string
cooperative_business_id:
type: integer
cooperative_name:
description: 合作商名称
type: string
createBy:
type: string
createdAt:
type: string
dataScope:
type: string
deletedAt:
type: string
deptId:
description: 部门编码
type: integer
email:
description: 邮箱
type: string
nickName:
description: 昵称
type: string
params:
type: string
password:
description: 密码
type: string
phone:
description: 手机号
type: string
postId:
description: 职位编码
type: integer
remark:
description: 备注
type: string
roleId:
description: 角色编码
type: integer
salt:
description:
type: string
sex:
description: 性别
type: string
status:
type: string
store_id:
description: 门店id
type: integer
store_name:
description: 门店id
type: string
updateBy:
type: string
updatedAt:
type: string
userId:
description: 编码
type: integer
username:
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/wenjianzhang/go-admin/blob/master/LICENSE.md
title: go-admin API
version: 1.0.1
paths:
/api/v1/category/create:
post:
consumes:
- application/json
parameters:
- description: 商品分类创建模型
in: body
name: request
required: true
schema:
$ref: '#/definitions/basic.CreateCategoryRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
summary: 创建分类
tags:
- 商品分类
/api/v1/category/delete/:id:
delete:
parameters:
- description: 分类id
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
summary: 删除分类
tags:
- 商品分类
/api/v1/category/display:
post:
parameters:
- description: 隐藏或展示分类请求模型
in: body
name: request
required: true
schema:
$ref: '#/definitions/basic.CategoryDisplayRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
summary: 隐藏或展示分类
tags:
- 商品分类
/api/v1/category/list/:
get:
parameters:
- description: 分类列表请求模型
in: body
name: request
required: true
schema:
$ref: '#/definitions/basic.CategoryListRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/models.CategoryModel'
type: array
summary: 分类列表
tags:
- 商品分类
/api/v1/category/update:
post:
consumes:
- application/json
parameters:
- description: 商品分类编辑模型
in: body
name: request
required: true
schema:
$ref: '#/definitions/basic.UpdateCategoryRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Category'
summary: 编辑分类
tags:
- 商品分类
/api/v1/config:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysConfig'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改配置
tags:
- system/配置
/api/v1/config/{configId}:
delete:
description: 删除数据
parameters:
- description: configId
in: path
name: configId
required: true
type: integer
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 删除配置
tags:
- system/配置
get:
description: 获取JSON
parameters:
- description: 配置编码
in: path
name: configId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 获取配置
tags:
- system/配置
/api/v1/configKey/{configKey}:
get:
description: 获取JSON
parameters:
- description: configKey
in: path
name: configKey
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 获取配置
tags:
- system/配置
/api/v1/configList:
get:
description: 获取JSON
parameters:
- description: configKey
in: query
name: configKey
type: string
- description: configName
in: query
name: configName
type: string
- description: configType
in: query
name: configType
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/app.Response'
security:
- Bearer: []
summary: 配置列表数据
tags:
- system/配置
/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/app.Response'
summary: 分页列表数据 / page list data
tags:
- system/工具
/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/app.Response'
summary: 分页列表数据 / page list data
tags:
- system/工具
/api/v1/dept:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysDept'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加部门
tags:
- system/部门
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/models.SysDept'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改部门
tags:
- system/部门
/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/app.Response'
security:
- Bearer: []
summary: 部门列表数据
tags:
- system/部门
/api/v1/dept/{id}:
delete:
description: 删除数据
parameters:
- description: id
in: path
name: id
required: true
type: integer
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 删除部门
tags:
- system/部门
/api/v1/deptList:
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/app.Response'
security:
- Bearer: []
summary: 分页部门列表数据
tags:
- system/部门
/api/v1/dict/data:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.DictType'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加字典数据
tags:
- system/字典数据
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.DictType'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改字典数据
tags:
- system/字典数据
/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:
- system/字典数据
get:
description: 获取JSON
parameters:
- description: 字典编码
in: path
name: dictCode
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 通过编码获取字典数据
tags:
- system/字典数据
/api/v1/dict/data/list:
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/app.Response'
security:
- Bearer: []
summary: 字典数据列表
tags:
- system/字典数据
/api/v1/dict/databyType/{dictType}:
get:
description: 获取JSON
parameters:
- description: dictType
in: path
name: dictType
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 通过字典类型获取字典数据
tags:
- system/字典数据
/api/v1/dict/type:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.DictType'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加字典类型
tags:
- system/字典类型
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.DictType'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改字典类型
tags:
- system/字典类型
/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:
- system/字典类型
get:
description: 获取JSON
parameters:
- description: 字典类型编码
in: path
name: dictId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 通过字典id获取字典类型
tags:
- system/字典类型
/api/v1/dict/type/list:
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/app.Page'
security:
- Bearer: []
summary: 字典类型列表数据
tags:
- system/字典类型
/api/v1/loginlog:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.LoginLog'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加登录日志
tags:
- system/日志
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.LoginLog'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改登录日志
tags:
- system/日志
/api/v1/loginlog/{infoId}:
delete:
description: 删除数据
parameters:
- description: 以逗号(,分割的infoId
in: path
name: infoId
required: true
type: string
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 批量删除登录日志
tags:
- system/日志
get:
description: 获取JSON
parameters:
- description: infoId
in: path
name: infoId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 通过编码获取登录日志
tags:
- system/日志
/api/v1/loginloglist:
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/app.Response'
security:
- Bearer: []
summary: 登录日志列表
tags:
- system/日志
/api/v1/menu:
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:
- system/菜单
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:
- system/菜单
/api/v1/menu/{id}:
delete:
description: 删除数据
parameters:
- description: id
in: path
name: id
required: true
type: integer
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 删除菜单
tags:
- system/菜单
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/models.Menu'
responses:
"200":
description: '{"code": -1, "message": "修改失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改菜单
tags:
- system/菜单
/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:
- system/菜单
/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:
- system/菜单
/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:
- system/菜单
/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:
- system/菜单
/api/v1/operlog:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysOperLog'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加操作日志
tags:
- system/日志
/api/v1/operlog/{infoId}:
get:
description: 获取JSON
parameters:
- description: infoId
in: path
name: infoId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 通过编码获取登录日志
tags:
- system/日志
/api/v1/operlog/{operId}:
delete:
description: 删除数据
parameters:
- description: 以逗号(,分割的operId
in: path
name: operId
required: true
type: string
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 批量删除操作日志
tags:
- system/日志
/api/v1/operloglist:
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/app.Response'
security:
- Bearer: []
summary: 登录日志列表
tags:
- system/日志
/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/app.Response'
security:
- Bearer: []
summary: 岗位列表数据
tags:
- system/岗位
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.Post'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加岗位
tags:
- system/岗位
/api/v1/post/:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.Post'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改岗位
tags:
- system/岗位
/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:
- system/岗位
get:
description: 获取JSON
parameters:
- description: postId
in: path
name: postId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 获取岗位信息
tags:
- system/岗位
/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:
- system/公共接口
/api/v1/role:
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:
- system/角色
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysRole'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
summary: 创建角色
tags:
- system/角色
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysRole'
responses:
"200":
description: '{"code": -1, "message": "修改失败"}'
schema:
type: string
summary: 修改用户角色
tags:
- system/角色
/api/v1/role/{roleId}:
delete:
description: 删除数据
parameters:
- description: roleId
in: path
name: roleId
required: true
type: integer
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 删除用户角色
tags:
- system/角色
/api/v1/rolelist:
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/app.Response'
security:
- Bearer: []
summary: 角色列表数据
tags:
- system/角色
/api/v1/rolemenu:
get:
description: 获取JSON
parameters:
- description: RoleId
in: query
name: RoleId
type: string
responses:
"200":
description: '{"code": -1, "message": "抱歉未找到相关信息"}'
schema:
type: string
security:
- Bearer: []
summary: RoleMenu列表数据
tags:
- system/角色菜单
/api/v1/rolemenu/{id}:
delete:
description: 删除数据
parameters:
- description: id
in: path
name: id
required: true
type: string
- description: menu_id
in: query
name: menu_id
type: string
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 删除用户菜单数据
tags:
- system/角色菜单
/api/v1/setting:
get:
description: 获取JSON
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
summary: 查询系统信息
tags:
- system/系统信息
/api/v1/settings/serverInfo:
get:
description: 获取JSON
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
summary: 系统信息
tags:
- system/系统信息
/api/v1/supplier/create:
post:
consumes:
- application/json
parameters:
- description: 供应商模型
in: body
name: request
required: true
schema:
$ref: '#/definitions/basic.SupplierCreateRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Supplier'
summary: 创建供应商
tags:
- 供应商管理
/api/v1/supplier/delete/{id}:
delete:
parameters:
- description: 供应商id
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
summary: 删除供应商
tags:
- 供应商管理
/api/v1/supplier/detail/{id}:
get:
parameters:
- description: 供应商id
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.Supplier'
summary: 供应商详情
tags:
- 供应商管理
/api/v1/supplier/list:
post:
consumes:
- application/json
parameters:
- description: 供应商查询模型
in: body
name: request
required: true
schema:
$ref: '#/definitions/basic.SupplierListRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/models.Supplier'
type: array
summary: 供应商列表
tags:
- 供应商管理
/api/v1/supplier/update:
post:
consumes:
- application/json
parameters:
- description: 供应商模型
in: body
name: request
required: true
schema:
$ref: '#/definitions/basic.SupplierUpdateRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.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:
- system/工具
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:
- system/工具
/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:
- system/工具
get:
description: 获取JSON
parameters:
- description: configKey
in: path
name: configKey
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 获取配置
tags:
- system/工具
/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/app.Response'
summary: 分页列表数据
tags:
- system/工具
/api/v1/sysUser:
get:
description: 获取JSON
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 获取用户角色和职位
tags:
- system/用户
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: 用户数据
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysUser'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
summary: 创建用户
tags:
- system/用户
/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/app.Response'
security:
- Bearer: []
summary: 获取用户
tags:
- system/用户
/api/v1/sysUserList:
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:
- system/用户
/api/v1/syscategory:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysCategory'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
summary: 添加分类
tags:
- system/分类
/api/v1/syscontent:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysContent'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
summary: 添加内容管理
tags:
- system/内容管理
/api/v1/sysfiledir:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysFileDir'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
summary: 添加SysFileDir
tags:
- system/file
/api/v1/system/setting:
post:
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysUser'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
summary: 更新或提交系统信息
tags:
- system/系统信息
/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:
- system/用户
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.SysUser'
responses:
"200":
description: '{"code": -1, "message": "修改失败"}'
schema:
type: string
summary: 修改用户数据
tags:
- system/用户
/api/v1/user/profile:
get:
description: 获取JSON
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/app.Response'
security:
- Bearer: []
summary: 获取个人中心用户
tags:
- system/用户
/api/v1/user/profileAvatar:
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:
- system/用户
/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 modeIt 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/models.Login'
responses:
"200":
description: '{"code": 200, "expire": "2019-08-07T12:45:48+08:00", "token":
".eyJleHAiOjE1NjUxNTMxNDgsImlkIjoiYWRtaW4iLCJvcmlnX2lhdCI6MTU2NTE0OTU0OH0.-zvzHvbg0A"
}'
schema:
type: string
summary: 登陆
tags:
- system/用户
/logout:
post:
consumes:
- application/json
description: 获取token
responses:
"200":
description: '{"code": 200, "msg": "成功退出系统" }'
schema:
type: string
security:
- Bearer: []
summary: 退出登录
tags:
- system/用户
securityDefinitions:
Bearer:
in: header
name: Authorization
type: apiKey
swagger: "2.0"