public/PandaX
1
0
Fork 0
mirror of https://gitee.com/XM-GO/PandaX.git synced 2026-04-23 10:58:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
44bde7a07c7890184e866809efd0f9d953743b61
PandaX/docs/docs.go
PandaGoAdmin 433ee08634 【升级go 1.18】
2022-07-13 11:54:54 +08:00

4631 lines
145 KiB
Go
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.
// Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag
package docs
import (
"bytes"
"encoding/json"
"strings"
"text/template"
"github.com/swaggo/swag"
)
var doc = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/api/api": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "创建基础api",
"parameters": [
{
"description": "api路径, api中文描述, api组, 方法",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysApi"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/casbin/getPolicyPathByRoleId": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "获取Api权限列表",
"parameters": [
{
"type": "string",
"description": "权限id, 权限模型列表",
"name": "roleKey",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/gen/code/{tableId}": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"工具 / 生成工具"
],
"summary": "代码生成",
"parameters": [
{
"type": "integer",
"description": "tableId",
"name": "tableId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/gen/preview/{tableId}": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"工具 / 生成工具"
],
"summary": "代码视图",
"parameters": [
{
"type": "integer",
"description": "tableId",
"name": "tableId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/table": {
"put": {
"security": [
{
"Bearer": []
}
],
"description": "修改表结构",
"consumes": [
"application/json"
],
"tags": [
"工具 / 生成工具"
],
"summary": "修改表结构",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.DevGenTable"
}
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "添加表结构",
"consumes": [
"application/json"
],
"tags": [
"工具 / 生成工具"
],
"summary": "添加表结构",
"parameters": [
{
"type": "string",
"description": "tableName / 数据表名称",
"name": "tableName",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/table/db/list": {
"get": {
"description": "数据库表列分页列表 / database table column page list",
"tags": [
"工具 / 生成工具"
],
"summary": "分页列表数据 / page list data",
"parameters": [
{
"type": "string",
"description": "tableName / 数据表名称",
"name": "tableName",
"in": "query"
},
{
"type": "integer",
"description": "pageSize / 页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "pageNum / 页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/table/info/tableName": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"工具 / 生成工具"
],
"summary": "获取表信息",
"parameters": [
{
"type": "string",
"description": "tableName / 数据表名称",
"name": "tableName",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/table/info/{tableId}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取JSON",
"tags": [
"工具 / 生成工具"
],
"summary": "获取表信息",
"parameters": [
{
"type": "integer",
"description": "tableId",
"name": "tableId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/table/list": {
"get": {
"description": "生成表分页列表",
"tags": [
"工具 / 生成工具"
],
"summary": "分页列表数据",
"parameters": [
{
"type": "string",
"description": "tableName / 数据表名称",
"name": "tableName",
"in": "query"
},
{
"type": "string",
"description": "tableComment / 数据表描述",
"name": "tableComment",
"in": "query"
},
{
"type": "integer",
"description": "pageSize / 页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "pageIndex / 页码",
"name": "pageIndex",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/table/tableTree": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"工具 / 生成工具"
],
"summary": "获取树表信息",
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/develop/code/table/{tableId}": {
"delete": {
"description": "删除表结构",
"tags": [
"工具 / 生成工具"
],
"summary": "删除表结构",
"parameters": [
{
"type": "integer",
"description": "tableId",
"name": "tableId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/job": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"任务"
],
"summary": "修改JOB",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysJob"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/job/changeStatus": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"任务"
],
"summary": "修改JOB状态",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/from.JobStatus"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/job/job": {
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"任务"
],
"summary": "添加任务",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysJob"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/job/list": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"任务"
],
"summary": "job列表",
"parameters": [
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "jobName",
"name": "jobName",
"in": "query"
},
{
"type": "string",
"description": "jobGroup",
"name": "jobGroup",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/job/stop/{jobId}": {
"get": {
"description": "开始Job",
"tags": [
"任务"
],
"summary": "开始JOB",
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/job/{jobId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"任务"
],
"summary": "获取一个job",
"parameters": [
{
"type": "integer",
"description": "jobId",
"name": "jobId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"任务"
],
"summary": "批量删除JOB",
"parameters": [
{
"type": "string",
"description": "以逗号（,）分割的infoId",
"name": "infoId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logJob/all": {
"delete": {
"description": "删除数据",
"tags": [
"任务日志"
],
"summary": "清空登录日志",
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logJob/list": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"任务日志"
],
"summary": "Job日志列表",
"parameters": [
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "jobGroup",
"name": "jobGroup",
"in": "query"
},
{
"type": "string",
"description": "name",
"name": "name",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logJob/{logId}": {
"delete": {
"description": "删除数据",
"tags": [
"任务日志"
],
"summary": "批量删除登录日志",
"parameters": [
{
"type": "string",
"description": "以逗号（,）分割的logId",
"name": "logId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logLogin": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"登录日志"
],
"summary": "修改登录日志",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.LogLogin"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logLogin/all": {
"delete": {
"description": "删除数据",
"tags": [
"登录日志"
],
"summary": "清空登录日志",
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logLogin/list": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"登录日志"
],
"summary": "登录日志列表",
"parameters": [
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "username",
"name": "username",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logLogin/{infoId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"登录日志"
],
"summary": "通过编码获取登录日志",
"parameters": [
{
"type": "integer",
"description": "infoId",
"name": "infoId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"登录日志"
],
"summary": "批量删除登录日志",
"parameters": [
{
"type": "string",
"description": "以逗号（,）分割的infoId",
"name": "infoId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logOper/all": {
"delete": {
"description": "删除数据",
"tags": [
"操作日志"
],
"summary": "清空操作日志",
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logOper/list": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"操作日志"
],
"summary": "操作日志列表",
"parameters": [
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "operName",
"name": "operName",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/log/logOper/{operId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"操作日志"
],
"summary": "通过编码获取操作日志",
"parameters": [
{
"type": "integer",
"description": "operId",
"name": "operId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"操作日志"
],
"summary": "批量删除操作日志",
"parameters": [
{
"type": "string",
"description": "以逗号（,）分割的operId",
"name": "operId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/email": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"ResEmails"
],
"summary": "修改ResEmails",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.ResEmail"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"ResEmails"
],
"summary": "添加ResEmails",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.ResEmail"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/email/debugMail": {
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"ResEmails"
],
"summary": "测试发邮件",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/from.SendMail"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/email/list": {
"get": {
"security": [
{
"": []
}
],
"tags": [
"ResEmails"
],
"summary": "ResEmails列表数据",
"parameters": [
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
},
{
"type": "string",
"description": "状态",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "分类",
"name": "category",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/email/{mailId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"ResEmails"
],
"summary": "获取ResEmails",
"parameters": [
{
"type": "integer",
"description": "mailId",
"name": "mailId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"ResEmails"
],
"summary": "删除ResEmails",
"parameters": [
{
"type": "string",
"description": "mailId",
"name": "mailId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/oss": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"ResOsses"
],
"summary": "修改ResOsses状态",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.ResOss"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"ResOsses"
],
"summary": "添加ResOsses",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.ResOss"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/oss/list": {
"get": {
"security": [
{
"": []
}
],
"tags": [
"ResOsses"
],
"summary": "ResOsses列表数据",
"parameters": [
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
},
{
"type": "string",
"description": "状态",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "分类",
"name": "category",
"in": "query"
},
{
"type": "string",
"description": "编号",
"name": "ossCode",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/oss/uploadFile": {
"post": {
"description": "上传文件",
"tags": [
"ResOsses"
],
"summary": "上传文件ResOsses",
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/resource/oss/{ossId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"ResOsses"
],
"summary": "获取ResOsses",
"parameters": [
{
"type": "integer",
"description": "ossId",
"name": "ossId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"ResOsses"
],
"summary": "删除ResOsses",
"parameters": [
{
"type": "string",
"description": "ossId",
"name": "ossId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/api": {
"post": {
"security": [
{
"X-TOKEN": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "创建基础api",
"parameters": [
{
"description": "api路径, api中文描述, api组, 方法",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysApi"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/api/all": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "获取所有的Api 不分页",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/api/list": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "分页获取API列表",
"parameters": [
{
"type": "string",
"description": "path",
"name": "path",
"in": "query"
},
{
"type": "string",
"description": "description",
"name": "description",
"in": "query"
},
{
"type": "string",
"description": "method",
"name": "method",
"in": "query"
},
{
"type": "string",
"description": "apiGroup",
"name": "apiGroup",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/api/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "根据id获取api",
"parameters": [
{
"type": "integer",
"description": "根据id获取api",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"security": [
{
"X-TOKEN": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysApi"
],
"summary": "删除api",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/config": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"配置"
],
"summary": "配置列表数据",
"parameters": [
{
"type": "string",
"description": "configName",
"name": "configName",
"in": "query"
},
{
"type": "string",
"description": "configKey",
"name": "configKey",
"in": "query"
},
{
"type": "string",
"description": "configType",
"name": "configType",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"配置"
],
"summary": "修改配置",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysConfig"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"配置"
],
"summary": "添加配置",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysConfig"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/config/configKey": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"配置"
],
"summary": "配置列表数据ByKey",
"parameters": [
{
"type": "string",
"description": "configKey",
"name": "configKey",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/config/{configId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"配置"
],
"summary": "获取配置",
"parameters": [
{
"type": "integer",
"description": "configId",
"name": "configId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"配置"
],
"summary": "删除配置",
"parameters": [
{
"type": "string",
"description": "configId 多个使用逗号分割",
"name": "configId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dept": {
"put": {
"security": [
{
"Bearer": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"部门"
],
"summary": "修改部门",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysDept"
}
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"部门"
],
"summary": "添加部门",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysDept"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dept/deptList": {
"get": {
"security": [
{
"": []
}
],
"description": "分页列表",
"tags": [
"部门"
],
"summary": "部门列表数据",
"parameters": [
{
"type": "string",
"description": "deptName",
"name": "deptName",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "integer",
"description": "deptId",
"name": "deptId",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dept/deptTree": {
"get": {
"security": [
{
"": []
}
],
"description": "部门树列表",
"tags": [
"部门"
],
"summary": "所有部门树数据",
"parameters": [
{
"type": "string",
"description": "deptName",
"name": "deptName",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "integer",
"description": "deptId",
"name": "deptId",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dept/ordinaryDeptLis": {
"get": {
"security": [
{
"": []
}
],
"description": "部门列表",
"tags": [
"部门"
],
"summary": "所有部门列表数据",
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dept/{deptId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"部门"
],
"summary": "部门数据",
"parameters": [
{
"type": "string",
"description": "deptId",
"name": "deptId",
"in": "path"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"部门"
],
"summary": "删除部门",
"parameters": [
{
"type": "string",
"description": "deptId, 逗号隔开",
"name": "deptId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/data": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"字典"
],
"summary": "修改字典数据",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysDictData"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"字典"
],
"summary": "添加字典数据",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysDictData"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/data/list": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"字典"
],
"summary": "字典数据列表",
"parameters": [
{
"type": "string",
"description": "dictLabel",
"name": "dictLabel",
"in": "query"
},
{
"type": "string",
"description": "dictType",
"name": "dictType",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/data/type": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"字典"
],
"summary": "字典数据获取",
"parameters": [
{
"type": "string",
"description": "dictType",
"name": "dictType",
"in": "path"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/data/{dictCode}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"字典"
],
"summary": "获取字典数据",
"parameters": [
{
"type": "integer",
"description": "dictCode",
"name": "dictCode",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"字典"
],
"summary": "删除字典数据",
"parameters": [
{
"type": "string",
"description": "dictCode ",
"name": "dictCode",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/type": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"职位"
],
"summary": "修改字典类型",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysDictType"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"字典"
],
"summary": "添加字典类型",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysDictType"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/type/export": {
"get": {
"description": "导出数据",
"tags": [
"用户"
],
"summary": "导出用户",
"parameters": [
{
"type": "string",
"description": "userName",
"name": "userName",
"in": "query"
},
{
"type": "string",
"description": "phone",
"name": "phone",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/type/list": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"职位"
],
"summary": "字典类型列表数据",
"parameters": [
{
"type": "string",
"description": "DictName",
"name": "dictName",
"in": "query"
},
{
"type": "string",
"description": "dictType",
"name": "dictName",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dict/type/{dictId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"字典"
],
"summary": "获取字典类型",
"parameters": [
{
"type": "integer",
"description": "dictId",
"name": "dictId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"字典"
],
"summary": "删除字典类型",
"parameters": [
{
"type": "string",
"description": "dictId ",
"name": "dictId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/menu": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "修改菜单",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysMenu"
}
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"修改失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "创建菜单",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysMenu"
}
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/menu/menuList": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "Menu列表数据",
"parameters": [
{
"type": "string",
"description": "menuName",
"name": "menuName",
"in": "query"
},
{
"type": "string",
"description": "IsHide",
"name": "IsHide",
"in": "query"
},
{
"type": "string",
"description": "title",
"name": "title",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/menu/menuPaths": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "获取角色对应的菜单路径数组",
"parameters": [
{
"type": "string",
"description": "roleKey",
"name": "roleKey",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/menu/menuRole": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "登陆成功获取的路由，根据角色名称获取菜单列表数据（左菜单使用）",
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/menu/menuTreRoleSelect/{roleId}": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "获取角色的菜单树",
"parameters": [
{
"type": "integer",
"description": "roleId",
"name": "roleId",
"in": "path"
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/menu/menuTreSelect": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "获取菜单树",
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/menu/{menuId}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "Menu列表数据",
"parameters": [
{
"type": "string",
"description": "menuId",
"name": "menuId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"菜单"
],
"summary": "删除菜单",
"parameters": [
{
"type": "integer",
"description": "menuId",
"name": "menuId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/notice": {
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"通知"
],
"summary": "修改通知",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysNotice"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"通知"
],
"summary": "添加通知",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysNotice"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/notice/{noticeId}": {
"delete": {
"description": "删除数据",
"tags": [
"通知"
],
"summary": "删除通知",
"parameters": [
{
"type": "string",
"description": "noticeId ",
"name": "noticeId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/post": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"职位"
],
"summary": "职位列表数据",
"parameters": [
{
"type": "string",
"description": "postName",
"name": "postName",
"in": "query"
},
{
"type": "string",
"description": "postCode",
"name": "postCode",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"put": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"职位"
],
"summary": "修改职位",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysPost"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"职位"
],
"summary": "添加职位",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysPost"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/post/{postId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"职位"
],
"summary": "获取职位",
"parameters": [
{
"type": "integer",
"description": "postId",
"name": "postId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "删除数据",
"tags": [
"职位"
],
"summary": "删除职位",
"parameters": [
{
"type": "string",
"description": "postId ",
"name": "postId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/role": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"角色/Role"
],
"summary": "获取Role数据",
"parameters": [
{
"type": "string",
"description": "roleId",
"name": "roleId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"角色/Role"
],
"summary": "修改用户角色",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysRole"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"修改失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"角色/Role"
],
"summary": "创建角色",
"parameters": [
{
"description": "data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysRole"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/role/changeStatus": {
"put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"角色/Role"
],
"summary": "修改用户角色状态",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysRole"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"修改失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/role/dataScope": {
"put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"角色/Role"
],
"summary": "修改用户角色部门",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysRole"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"修改失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/role/rolelist": {
"get": {
"security": [
{
"": []
}
],
"description": "Get JSON",
"tags": [
"角色"
],
"summary": "角色列表数据",
"parameters": [
{
"type": "string",
"description": "roleName",
"name": "roleName",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "roleKey",
"name": "roleKey",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/role/{roleId}": {
"delete": {
"description": "删除数据",
"tags": [
"角色/Role"
],
"summary": "删除用户角色",
"parameters": [
{
"type": "string",
"description": "roleId 多个用，分割",
"name": "roleId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/getCaptcha": {
"get": {
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "获取验证码",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/getInit": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"用户"
],
"summary": "获取添加用户角色和职位",
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/login": {
"post": {
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "用户登录",
"parameters": [
{
"description": "用户名, 密码, 验证码",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/form.Login"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/logout": {
"post": {
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "退出登录",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/profile": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"个人中心"
],
"summary": "获取当前登录用户",
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/profileAvatar": {
"post": {
"description": "修改头像",
"tags": [
"用户"
],
"summary": "修改头像",
"parameters": [
{
"type": "file",
"description": "file",
"name": "file",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/refreshToken": {
"get": {
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "刷新token",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/sysUser": {
"put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"用户"
],
"summary": "修改用户状态",
"parameters": [
{
"description": "用户数据",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysUser"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
},
"post": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"用户"
],
"summary": "创建用户",
"parameters": [
{
"description": "用户数据",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysUser"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/sysUser/{userId}": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"用户"
],
"summary": "获取用户",
"parameters": [
{
"type": "integer",
"description": "用户编码",
"name": "userId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/sysUserList": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"用户"
],
"summary": "列表数据",
"parameters": [
{
"type": "string",
"description": "userName",
"name": "userName",
"in": "query"
},
{
"type": "string",
"description": "phone",
"name": "phone",
"in": "query"
},
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "integer",
"description": "页条数",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "pageNum",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/sysuser/{userId}": {
"delete": {
"description": "删除数据",
"tags": [
"用户"
],
"summary": "删除用户数据",
"parameters": [
{
"type": "integer",
"description": "多个id 使用逗号隔开",
"name": "userId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/updatePwd": {
"post": {
"description": "修改密码",
"tags": [
"用户"
],
"summary": "修改密码",
"parameters": [
{
"description": "pwd",
"name": "pwd",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysUserPwd"
}
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"添加失败\"}",
"schema": {
"type": "string"
}
}
}
}
}
},
"definitions": {
"casbin.CasbinRule": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"ptype": {
"type": "string"
},
"roleKey": {
"type": "string"
},
"v3": {
"type": "string"
},
"v4": {
"type": "string"
},
"v5": {
"type": "string"
}
}
},
"entity.DevGenTable": {
"type": "object",
"properties": {
"businessName": {
"description": "生成业务名",
"type": "string"
},
"className": {
"description": "实体类名称",
"type": "string"
},
"columns": {
"description": "字段信息",
"type": "array",
"items": {
"$ref": "#/definitions/entity.DevGenTableColumn"
}
},
"create_time": {
"type": "string"
},
"functionAuthor": {
"description": "生成功能作者",
"type": "string"
},
"functionName": {
"description": "生成功能名",
"type": "string"
},
"moduleName": {
"description": "生成模块名",
"type": "string"
},
"options": {
"description": "其它生成选项",
"type": "string"
},
"packageName": {
"description": "生成包路径",
"type": "string"
},
"pkColumn": {
"type": "string"
},
"pkGoField": {
"type": "string"
},
"pkJsonField": {
"type": "string"
},
"remark": {
"description": "备注",
"type": "string"
},
"tableComment": {
"description": "表描述",
"type": "string"
},
"tableId": {
"description": "编号",
"type": "integer"
},
"tableName": {
"description": "表名称",
"type": "string"
},
"tplCategory": {
"description": "使用的模板（crud单表操作 tree树表操作）",
"type": "string"
},
"treeCode": {
"type": "string"
},
"treeName": {
"type": "string"
},
"treeParentCode": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.DevGenTableColumn": {
"type": "object",
"properties": {
"columnComment": {
"description": "列描述",
"type": "string"
},
"columnId": {
"description": "编号",
"type": "integer"
},
"columnKey": {
"type": "string"
},
"columnName": {
"description": "列名称",
"type": "string"
},
"columnType": {
"description": "列类型",
"type": "string"
},
"dictType": {
"description": "字典类型",
"type": "string"
},
"goField": {
"description": "Go字段名",
"type": "string"
},
"goType": {
"description": "Go类型",
"type": "string"
},
"htmlField": {
"description": "html字段名",
"type": "string"
},
"htmlType": {
"description": "显示类型（文本框、文本域、下拉框、复选框、单选框、日期控件）",
"type": "string"
},
"isEdit": {
"description": "是否编辑字段（1是）",
"type": "string"
},
"isIncrement": {
"description": "是否自增（1是）",
"type": "string"
},
"isInsert": {
"description": "是否为插入字段（1是）",
"type": "string"
},
"isList": {
"description": "是否列表字段（1是）",
"type": "string"
},
"isPk": {
"description": "是否主键（1是）",
"type": "string"
},
"isQuery": {
"description": "是否查询字段（1是）",
"type": "string"
},
"isRequired": {
"description": "是否必填（1是）",
"type": "string"
},
"jsonField": {
"type": "string"
},
"linkLabelId": {
"description": "关联表键名",
"type": "string"
},
"linkLabelName": {
"description": "关联表字段值",
"type": "string"
},
"linkTableClass": {
"description": "关联表类名",
"type": "string"
},
"linkTableName": {
"description": "关联表名",
"type": "string"
},
"linkTablePackage": {
"description": "关联表包名",
"type": "string"
},
"queryType": {
"description": "查询方式（等于、不等于、大于、小于、范围）",
"type": "string"
},
"sort": {
"description": "排序",
"type": "integer"
},
"tableId": {
"description": "归属表编号",
"type": "integer"
},
"tableName": {
"type": "string"
}
}
},
"entity.LogLogin": {
"type": "object",
"properties": {
"browser": {
"type": "string"
},
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"infoId": {
"description": "主键",
"type": "integer"
},
"ipaddr": {
"type": "string"
},
"loginLocation": {
"type": "string"
},
"loginTime": {
"type": "string"
},
"msg": {
"type": "string"
},
"os": {
"type": "string"
},
"params": {
"type": "string"
},
"platform": {
"type": "string"
},
"remark": {
"description": "备注",
"type": "string"
},
"status": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"entity.ResEmail": {
"type": "object",
"properties": {
"category": {
"description": "0 163邮箱，1 qq邮箱 2 企业邮箱",
"type": "string"
},
"create_time": {
"type": "string"
},
"from": {
"description": "邮箱账号",
"type": "string"
},
"host": {
"description": "服务器地址",
"type": "string"
},
"isSsl": {
"description": "是否开启ssl",
"type": "boolean"
},
"mailId": {
"type": "integer"
},
"nickname": {
"description": "发件人",
"type": "string"
},
"port": {
"description": "服务器端口",
"type": "integer"
},
"secret": {
"description": "邮箱密码",
"type": "string"
},
"status": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.ResOss": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"appId": {
"type": "string"
},
"bucketName": {
"type": "string"
},
"category": {
"description": "0 阿里云 1.七牛云 2. 腾讯云",
"type": "string"
},
"create_time": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"ossCode": {
"type": "string"
},
"ossId": {
"type": "integer"
},
"region": {
"type": "string"
},
"remark": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"status": {
"description": "0.启用 1.禁止",
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysApi": {
"type": "object",
"required": [
"path"
],
"properties": {
"apiGroup": {
"description": "api组",
"type": "string"
},
"create_time": {
"type": "string"
},
"description": {
"description": "api中文描述",
"type": "string"
},
"id": {
"type": "integer"
},
"method": {
"description": "方法:创建POST(默认)|查看GET|更新PUT|删除DELETE",
"type": "string"
},
"path": {
"description": "api路径",
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysConfig": {
"type": "object",
"properties": {
"configId": {
"type": "integer"
},
"configKey": {
"type": "string"
},
"configName": {
"type": "string"
},
"configType": {
"type": "string"
},
"configValue": {
"type": "string"
},
"create_time": {
"type": "string"
},
"isFrontend": {
"type": "string"
},
"remark": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysDept": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.SysDept"
}
},
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"deptId": {
"description": "部门编码",
"type": "integer"
},
"deptName": {
"type": "string"
},
"deptPath": {
"type": "string"
},
"email": {
"type": "string"
},
"leader": {
"description": "userId",
"type": "string"
},
"parentId": {
"type": "integer"
},
"phone": {
"type": "string"
},
"sort": {
"type": "integer"
},
"status": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysDictData": {
"type": "object",
"properties": {
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"cssClass": {
"type": "string"
},
"dictCode": {
"type": "integer"
},
"dictLabel": {
"type": "string"
},
"dictSort": {
"type": "integer"
},
"dictType": {
"type": "string"
},
"dictValue": {
"type": "string"
},
"isDefault": {
"type": "string"
},
"listClass": {
"type": "string"
},
"remark": {
"type": "string"
},
"status": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysDictType": {
"type": "object",
"properties": {
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"dictId": {
"type": "integer"
},
"dictName": {
"type": "string"
},
"dictType": {
"type": "string"
},
"remark": {
"type": "string"
},
"status": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysJob": {
"type": "object",
"properties": {
"args": {
"description": "目标参数",
"type": "string"
},
"concurrent": {
"description": "是否并发",
"type": "string"
},
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"cronExpression": {
"description": "cron表达式",
"type": "string"
},
"entryId": {
"description": "job启动时返回的id",
"type": "integer"
},
"invokeTarget": {
"description": "调用目标",
"type": "string"
},
"jobGroup": {
"description": "任务分组",
"type": "string"
},
"jobId": {
"description": "编码",
"type": "integer"
},
"jobName": {
"description": "名称",
"type": "string"
},
"jobType": {
"description": "任务类型",
"type": "string"
},
"misfirePolicy": {
"description": "执行策略",
"type": "string"
},
"status": {
"description": "状态",
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysMenu": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.SysMenu"
}
},
"component": {
"description": "组件路径",
"type": "string"
},
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"icon": {
"type": "string"
},
"isAffix": {
"description": "是否固定在 tagsView 栏上（0是 1否）",
"type": "string"
},
"isHide": {
"description": "显示状态（0显示 1隐藏）",
"type": "string"
},
"isIframe": {
"description": "是否为内嵌",
"type": "string"
},
"isKeepAlive": {
"description": "是否缓存组件状态（0是 1否）",
"type": "string"
},
"isLink": {
"description": "是否超链接菜单",
"type": "string"
},
"menuId": {
"type": "integer"
},
"menuName": {
"type": "string"
},
"menuType": {
"description": "菜单类型（M目录 C菜单 F按钮）",
"type": "string"
},
"parentId": {
"type": "integer"
},
"path": {
"type": "string"
},
"permission": {
"description": "权限标识",
"type": "string"
},
"remark": {
"description": "备注",
"type": "string"
},
"sort": {
"type": "integer"
},
"status": {
"description": "菜单状态（0正常 1停用）",
"type": "string"
},
"title": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysNotice": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"create_time": {
"type": "string"
},
"deptId": {
"type": "integer"
},
"deptIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"noticeId": {
"type": "integer"
},
"noticeType": {
"type": "string"
},
"title": {
"type": "string"
},
"update_time": {
"type": "string"
},
"userName": {
"type": "string"
}
}
},
"entity.SysPost": {
"type": "object",
"properties": {
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"postCode": {
"type": "string"
},
"postId": {
"type": "integer"
},
"postName": {
"type": "string"
},
"remark": {
"type": "string"
},
"sort": {
"type": "integer"
},
"status": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysRole": {
"type": "object",
"properties": {
"apiIds": {
"type": "array",
"items": {
"$ref": "#/definitions/casbin.CasbinRule"
}
},
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"dataScope": {
"type": "string"
},
"deptIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"flag": {
"type": "string"
},
"menuIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"remark": {
"type": "string"
},
"roleId": {
"type": "integer"
},
"roleKey": {
"type": "string"
},
"roleName": {
"type": "string"
},
"roleSort": {
"type": "integer"
},
"status": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
}
}
},
"entity.SysUser": {
"type": "object",
"properties": {
"avatar": {
"description": "头像",
"type": "string"
},
"createBy": {
"type": "string"
},
"create_time": {
"type": "string"
},
"deptId": {
"description": "部门编码",
"type": "integer"
},
"email": {
"description": "邮箱",
"type": "string"
},
"nickName": {
"description": "昵称",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"phone": {
"description": "手机号",
"type": "string"
},
"postId": {
"description": "职位编码",
"type": "integer"
},
"postIds": {
"description": "多岗位",
"type": "string"
},
"remark": {
"description": "备注",
"type": "string"
},
"roleId": {
"description": "角色编码",
"type": "integer"
},
"roleIds": {
"description": "多角色",
"type": "string"
},
"salt": {
"description": "盐",
"type": "string"
},
"sex": {
"description": "性别",
"type": "string"
},
"status": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
},
"userId": {
"description": "编码",
"type": "integer"
},
"username": {
"type": "string"
}
}
},
"entity.SysUserPwd": {
"type": "object",
"properties": {
"newPassword": {
"type": "string"
},
"oldPassword": {
"type": "string"
}
}
},
"form.Login": {
"type": "object",
"properties": {
"captcha": {
"description": "验证码",
"type": "string"
},
"captchaId": {
"description": "验证码ID",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"username": {
"description": "用户名",
"type": "string"
}
}
},
"from.JobStatus": {
"type": "object",
"properties": {
"jobId": {
"type": "integer"
},
"status": {
"type": "string"
}
}
},
"from.SendMail": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"mailId": {
"type": "integer"
},
"subject": {
"type": "string"
},
"to": {
"type": "string"
}
}
}
}
}`
type swaggerInfo struct {
Version string
Host string
BasePath string
Schemes []string
Title string
Description string
}
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = swaggerInfo{
Version: "",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "",
Description: "",
}
type s struct{}
func (s *s) ReadDoc() string {
sInfo := SwaggerInfo
sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
t, err := template.New("swagger_info").Funcs(template.FuncMap{
"marshal": func(v any) string {
a, _ := json.Marshal(v)
return string(a)
},
"escape": func(v any) string {
// escape tabs
str := strings.Replace(v.(string), "\t", "\\t", -1)
// replace " with \", and if that results in \\", replace that with \\\"
str = strings.Replace(str, "\"", "\\\"", -1)
return strings.Replace(str, "\\\\\"", "\\\\\\\"", -1)
},
}).Parse(doc)
if err != nil {
return doc
}
var tpl bytes.Buffer
if err := t.Execute(&tpl, sInfo); err != nil {
return doc
}
return tpl.String()
}
func init() {
swag.Register("swagger", &s{})
}
Reference in New Issue View Git Blame Copy Permalink