goweb-gin-demo/docs/swagger.json

1068 lines
33 KiB
JSON
Raw Normal View History

2021-10-29 14:39:50 +08:00
{
"swagger": "2.0",
"info": {
"contact": {}
},
"paths": {
"/base/captcha": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "生成验证码",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"验证码获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/base/login": {
"post": {
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "用户登录",
"parameters": [
{
"description": "用户名, 密码, 验证码",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.Login"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/jwt/jsonInBlacklist": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Jwt"
],
"summary": "jwt加入黑名单",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"拉黑成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/addBaseMenu": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Menu"
],
"summary": "新增菜单",
"parameters": [
{
"description": "路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/web.SysBaseMenu"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"添加成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/addMenuAuthority": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AuthorityMenu"
],
"summary": "增加menu和角色关联关系",
"parameters": [
{
"description": "角色ID",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.AddMenuAuthorityInfo"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"添加成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/deleteBaseMenu": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Menu"
],
"summary": "删除菜单",
"parameters": [
{
"description": "菜单id",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.GetById"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/getBaseMenuById": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Menu"
],
"summary": "根据id获取菜单",
"parameters": [
{
"description": "菜单id",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.GetById"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/getBaseMenuTree": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"AuthorityMenu"
],
"summary": "获取用户动态路由",
"parameters": [
{
"description": "空",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.Empty"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/getMenu": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"AuthorityMenu"
],
"summary": "获取用户动态路由",
"parameters": [
{
"description": "空",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.Empty"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/getMenuAuthority": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AuthorityMenu"
],
"summary": "获取指定角色menu",
"parameters": [
{
"description": "角色ID",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.GetAuthorityId"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/getMenuList": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Menu"
],
"summary": "分页获取基础menu列表",
"parameters": [
{
"description": "页码, 每页大小",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.PageInfo"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/menu/updateBaseMenu": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Menu"
],
"summary": "更新菜单",
"parameters": [
{
"description": "路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/web.SysBaseMenu"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/changePassword": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "用户修改密码",
"parameters": [
{
"description": "用户名, 原密码, 新密码",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.ChangePasswordStruct"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/deleteUser": {
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "删除用户",
"parameters": [
{
"description": "用户ID",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.GetById"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/getUserInfo": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "获取用户信息",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/getUserList": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "分页获取用户列表",
"parameters": [
{
"description": "页码, 每页大小",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.PageInfo"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/register": {
"post": {
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "用户注册账号",
"parameters": [
{
"description": "用户名, 昵称, 密码, 角色ID",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.Register"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"注册成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/setUserAuthorities": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "设置用户权限",
"parameters": [
{
"description": "用户UUID, 角色ID",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.SetUserAuthorities"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/setUserAuthority": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "更改用户权限",
"parameters": [
{
"description": "用户UUID, 角色ID",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.SetUserAuth"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/user/setUserInfo": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysUser"
],
"summary": "设置用户信息",
"parameters": [
{
"description": "ID, 用户名, 昵称, 头像链接",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/web.SysUser"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"设置成功\"}",
"schema": {
"type": "string"
}
}
}
}
}
},
"definitions": {
"request.AddMenuAuthorityInfo": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "string"
},
"menus": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysBaseMenu"
}
}
}
},
"request.ChangePasswordStruct": {
"type": "object",
"properties": {
"newPassword": {
"description": "新密码",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"username": {
"description": "用户名",
"type": "string"
}
}
},
"request.Empty": {
"type": "object"
},
"request.GetAuthorityId": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "string"
}
}
},
"request.GetById": {
"type": "object",
"properties": {
"id": {
"description": "主键ID",
"type": "number"
}
}
},
"request.Login": {
"type": "object",
"properties": {
"captcha": {
"description": "验证码",
"type": "string"
},
"captchaId": {
"description": "验证码ID",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"username": {
"description": "用户名",
"type": "string"
}
}
},
"request.PageInfo": {
"type": "object",
"properties": {
"page": {
"description": "页码",
"type": "integer"
},
"pageSize": {
"description": "每页大小",
"type": "integer"
}
}
},
"request.Register": {
"type": "object",
"properties": {
"authorityId": {
"type": "string"
},
"authorityIds": {
"type": "array",
"items": {
"type": "string"
}
},
"headerImg": {
"type": "string"
},
"nickName": {
"type": "string"
},
"passWord": {
"type": "string"
},
"userName": {
"type": "string"
}
}
},
"request.SetUserAuth": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "string"
}
}
},
"request.SetUserAuthorities": {
"type": "object",
"properties": {
"authorityIds": {
"description": "角色ID",
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"type": "integer"
}
}
},
"web.SysAuthority": {
"type": "object",
"properties": {
"authorityId": {
"description": "角色ID",
"type": "string"
},
"authorityName": {
"description": "角色名",
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysAuthority"
}
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"dataAuthorityId": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysAuthority"
}
},
"defaultRouter": {
"description": "默认菜单(默认dashboard)",
"type": "string"
},
"deletedAt": {
"type": "string"
},
"menus": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysBaseMenu"
}
},
"parentId": {
"description": "父角色ID",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"web.SysBaseMenu": {
"type": "object",
"properties": {
"authoritys": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysAuthority"
}
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysBaseMenu"
}
},
"closeTab": {
"description": "自动关闭tab",
"type": "boolean"
},
"component": {
"description": "对应前端文件路径",
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"defaultMenu": {
"description": "是否是基础路由(开发中)",
"type": "boolean"
},
"hidden": {
"description": "是否在列表隐藏",
"type": "boolean"
},
"icon": {
"description": "菜单图标",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"keepAlive": {
"description": "是否缓存",
"type": "boolean"
},
"name": {
"description": "路由name",
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysBaseMenuParameter"
}
},
"parentId": {
"description": "父菜单ID",
"type": "string"
},
"path": {
"description": "路由path",
"type": "string"
},
"sort": {
"description": "排序标记",
"type": "integer"
},
"title": {
"description": "菜单名",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"web.SysBaseMenuParameter": {
"type": "object",
"properties": {
"createdAt": {
"description": "创建时间",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"key": {
"description": "地址栏携带参数的key",
"type": "string"
},
"sysBaseMenuID": {
"type": "integer"
},
"type": {
"description": "地址栏携带参数为params还是query",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
},
"value": {
"description": "地址栏携带参数的值",
"type": "string"
}
}
},
"web.SysUser": {
"type": "object",
"properties": {
"activeColor": {
"description": "活跃颜色",
"type": "string"
},
"authorities": {
"type": "array",
"items": {
"$ref": "#/definitions/web.SysAuthority"
}
},
"authority": {
"$ref": "#/definitions/web.SysAuthority"
},
"authorityId": {
"description": "用户角色ID",
"type": "string"
},
"baseColor": {
"description": "基础颜色",
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"headerImg": {
"description": "用户头像",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"nickName": {
"description": "用户昵称",
"type": "string"
},
"sideMode": {
"description": "用户侧边主题",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
},
"userName": {
"description": "用户登录名",
"type": "string"
},
"uuid": {
"description": "用户UUID",
"type": "string"
}
}
}
}
}