Files
PandaX/docs/swagger.json
feilong.teng@rheinchina.com cd824b7f0c 集成完成
2021-12-12 19:49:39 +08:00

892 lines
28 KiB
JSON

{
"swagger": "2.0",
"info": {
"contact": {}
},
"paths": {
"/api/db/:dbId/c-metadata": {
"get": {}
},
"/api/db/:dbId/exec-sql": {
"get": {}
},
"/api/db/:dbId/hint-tables": {
"get": {}
},
"/api/db/:dbId/sql": {
"get": {},
"post": {}
},
"/api/db/:dbId/t-metadata": {
"get": {}
},
"/api/dbs": {
"get": {}
},
"/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/deptAllList": {
"get": {
"security": [
{
"": []
}
],
"description": "部门列表",
"tags": [
"部门"
],
"summary": "所有部门列表数据",
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"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": "string",
"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": "string",
"description": "deptId",
"name": "deptId",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/dept/roleDeptTreSelect/{roleId}": {
"delete": {
"description": "获取角色部门树",
"tags": [
"部门"
],
"summary": "获取角色部门",
"parameters": [
{
"type": "integer",
"description": "roleId",
"name": "roleId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"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"
}
}
}
}
},
"/system/dept/{id}": {
"delete": {
"description": "删除数据",
"tags": [
"部门"
],
"summary": "删除部门",
"parameters": [
{
"type": "integer",
"description": "deptId",
"name": "deptId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "{\"code\": 400, \"message\": \"删除失败\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/log/logLoginList": {
"get": {
"security": [
{
"": []
}
],
"description": "获取JSON",
"tags": [
"登录日志"
],
"summary": "登录日志列表",
"parameters": [
{
"type": "string",
"description": "status",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "dictCode",
"name": "dictCode",
"in": "query"
},
{
"type": "string",
"description": "dictType",
"name": "dictType",
"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/menu/menuList": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "Menu列表数据",
"parameters": [
{
"type": "string",
"description": "menuName",
"name": "menuName",
"in": "query"
},
{
"type": "string",
"description": "visible",
"name": "visible",
"in": "query"
},
{
"type": "string",
"description": "title",
"name": "title",
"in": "query"
}
],
"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": "string",
"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/menuids/{menuName}": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"菜单"
],
"summary": "获取角色对应的菜单id数组",
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/post/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": "postId",
"name": "postId",
"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/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/user/captcha": {
"get": {
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "获取验证码",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/getInfo": {
"get": {
"security": [
{
"": []
}
],
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "用户统一信息",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"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/refreshToken": {
"get": {
"produces": [
"application/json"
],
"tags": [
"Base"
],
"summary": "刷新token",
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/system/user/sysUserList": {
"get": {
"security": [
{
"X-TOKEN": []
}
],
"description": "获取JSON",
"tags": [
"用户"
],
"summary": "列表数据",
"parameters": [
{
"description": "user",
"name": "user",
"in": "body",
"schema": {
"$ref": "#/definitions/entity.SysUser"
}
}
],
"responses": {
"200": {
"description": "{\"code\": -1, \"message\": \"抱歉未找到相关信息\"}",
"schema": {
"type": "string"
}
}
}
}
}
},
"definitions": {
"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": {
"description": "部门名称",
"type": "string"
},
"deptPath": {
"type": "string"
},
"email": {
"description": "邮箱",
"type": "string"
},
"leader": {
"description": "负责人",
"type": "integer"
},
"params": {
"type": "string"
},
"parentId": {
"description": "上级部门",
"type": "integer"
},
"phone": {
"description": "手机",
"type": "string"
},
"sort": {
"description": "排序",
"type": "integer"
},
"status": {
"description": "状态",
"type": "integer"
},
"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"
},
"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": "integer"
},
"updateBy": {
"type": "string"
},
"update_time": {
"type": "string"
},
"userId": {
"description": "编码",
"type": "integer"
},
"username": {
"type": "string"
}
}
},
"form.Login": {
"type": "object",
"properties": {
"captcha": {
"description": "验证码",
"type": "string"
},
"captchaId": {
"description": "验证码ID",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"username": {
"description": "用户名",
"type": "string"
}
}
}
}
}