|
|
{ "swagger": "2.0", "info": { "description": "This is a sample Server pets", "title": "Swagger Example API", "contact": {}, "license": {}, "version": "0.0.1" }, "basePath": "/", "paths": { "/api/createApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Api" ], "summary": "创建基础api", "parameters": [ { "description": "创建api", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.CreateApiParams" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/deleteApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Api" ], "summary": "删除指定api", "parameters": [ { "description": "删除api", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/dbModel.Api" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/getAllApis": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Api" ], "summary": "获取所有的Api 不分页", "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/getApiById": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Api" ], "summary": "根据id获取api", "parameters": [ { "description": "分页获取用户列表", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/modelInterface.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/getApiList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Api" ], "summary": "分页获取API列表", "parameters": [ { "description": "分页获取API列表", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/modelInterface.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/setAuthAndApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Api" ], "summary": "创建api和角色关系", "parameters": [ { "description": "创建api和角色关系", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.AuthAndPathIn" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/api/updataApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Api" ], "summary": "创建基础api", "parameters": [ { "description": "创建api", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.CreateApiParams" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/authority/createAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "authority" ], "summary": "创建角色", "parameters": [ { "description": "创建角色", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.CreateAuthorityPatams" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/authority/deleteAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "authority" ], "summary": "删除角色", "parameters": [ { "description": "删除角色", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.DeleteAuthorityPatams" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/authority/getAuthAndApi": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "authority" ], "summary": "获取本角色所有有权限的apiId", "parameters": [ { "description": "获取本角色所有有权限的apiId", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.GetAuthorityId" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/authority/getAuthorityList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "authority" ], "summary": "分页获取角色列表", "parameters": [ { "description": "分页获取用户列表", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/modelInterface.PageInfo" } } ], "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": { "type": "object", "$ref": "#/definitions/api.RegistAndLoginStuct" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}", "schema": { "type": "string" } } } } }, "/base/regist": { "post": { "produces": [ "application/json" ], "tags": [ "Base" ], "summary": "用户注册账号", "parameters": [ { "description": "用户注册接口", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.RegistAndLoginStuct" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"注册成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/deleteFile": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "FileUploadAndDownload" ], "summary": "删除文件", "parameters": [ { "description": "传入文件里面id即可", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/dbModel.FileUploadAndDownload" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"返回成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/getFileList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "FileUploadAndDownload" ], "summary": "分页文件列表", "parameters": [ { "description": "分页获取文件户列表", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/modelInterface.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/fileUploadAndDownload/upload": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "FileUploadAndDownload" ], "summary": "上传文件示例", "parameters": [ { "type": "file", "description": "上传文件示例", "name": "file", "in": "formData", "required": true } ], "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": "新增菜单", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/dbModel.BaseMenu" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/addMenuAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "authorityAndMenu" ], "summary": "获取指定角色menu", "parameters": [ { "description": "增加menu和角色关联关系", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.AuthorityIdInfo" } } ], "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": "删除菜单", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.IdInfo" } } ], "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": { "type": "object", "$ref": "#/definitions/api.GetById" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/getBaseMenuTree": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "authorityAndMenu" ], "summary": "获取用户动态路由", "parameters": [ { "description": "可以什么都不填", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.RegistAndLoginStuct" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"返回成功\"}", "schema": { "type": "string" } } } } }, "/menu/getMenu": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "authorityAndMenu" ], "summary": "获取用户动态路由", "parameters": [ { "description": "可以什么都不填", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.RegistAndLoginStuct" } } ], "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": "分页获取基础menu列表", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/modelInterface.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/menu/updataBaseMen": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "menu" ], "summary": "更新菜单", "parameters": [ { "description": "更新菜单", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/dbModel.BaseMenu" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/user/changePassword": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "用户修改密码", "parameters": [ { "description": "用户修改密码", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.ChangePasswordStutrc" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}", "schema": { "type": "string" } } } } }, "/user/getUserList": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "分页获取用户列表", "parameters": [ { "description": "分页获取用户列表", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/modelInterface.PageInfo" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}", "schema": { "type": "string" } } } } }, "/user/setUserAuthority": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "设置用户权限", "parameters": [ { "description": "设置用户权限", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/api.SetUserAuth" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}", "schema": { "type": "string" } } } } }, "/user/uploadHeaderImg": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "用户上传头像", "parameters": [ { "type": "file", "description": "用户上传头像", "name": "headerImg", "in": "formData", "required": true }, { "type": "string", "description": "用户上传头像", "name": "username", "in": "formData", "required": true } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"上传成功\"}", "schema": { "type": "string" } } } } }, "/workflow/createWorkFlow": { "post": { "produces": [ "application/json" ], "tags": [ "workflow" ], "summary": "注册工作流", "parameters": [ { "description": "注册工作流接口", "name": "data", "in": "body", "required": true, "schema": { "type": "object", "$ref": "#/definitions/dbModel.Workflow" } } ], "responses": { "200": { "description": "{\"success\":true,\"data\":{},\"msg\":\"注册成功\"}", "schema": { "type": "string" } } } } } }, "definitions": { "api.AddMenuAuthorityInfo": { "type": "object", "properties": { "authorityId": { "type": "string" }, "menus": { "type": "array", "items": { "$ref": "#/definitions/dbModel.BaseMenu" } } } }, "api.AuthAndPathIn": { "type": "object", "properties": { "apiIds": { "type": "array", "items": { "type": "integer" } }, "authorityId": { "type": "string" } } }, "api.AuthorityIdInfo": { "type": "object", "properties": { "authorityId": { "type": "string" } } }, "api.ChangePasswordStutrc": { "type": "object", "properties": { "newPassword": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } } }, "api.CreateApiParams": { "type": "object", "properties": { "description": { "type": "string" }, "path": { "type": "string" } } }, "api.CreateAuthorityPatams": { "type": "object", "properties": { "authorityId": { "type": "string" }, "authorityName": { "type": "string" } } }, "api.DeleteAuthorityPatams": { "type": "object", "properties": { "authorityId": { "type": "integer" } } }, "api.GetAuthorityId": { "type": "object", "properties": { "authorityId": { "type": "string" } } }, "api.GetById": { "type": "object", "properties": { "id": { "type": "number" } } }, "api.IdInfo": { "type": "object", "properties": { "id": { "type": "number" } } }, "api.RegistAndLoginStuct": { "type": "object", "properties": { "password": { "type": "string" }, "username": { "type": "string" } } }, "api.SetUserAuth": { "type": "object", "properties": { "authorityId": { "type": "string" }, "uuid": { "type": "string" } } }, "dbModel.Api": { "type": "object", "properties": { "description": { "type": "string" }, "group": { "type": "string" }, "path": { "type": "string" } } }, "dbModel.BaseMenu": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/dbModel.BaseMenu" } }, "component": { "type": "string" }, "hidden": { "type": "boolean" }, "icon": { "type": "string" }, "name": { "type": "string" }, "nickName": { "type": "string" }, "parentId": { "type": "string" }, "path": { "type": "string" }, "title": { "type": "string" } } }, "dbModel.FileUploadAndDownload": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "tag": { "type": "string" }, "url": { "type": "string" } } }, "dbModel.Workflow": { "type": "object", "properties": { "workflowDescription": { "description": "工作流描述", "type": "string" }, "workflowName": { "description": "工作流英文id", "type": "string" }, "workflowNickName": { "description": "工作流名称", "type": "string" }, "workflowStep": { "description": "工作流步骤", "type": "array", "items": { "$ref": "#/definitions/dbModel.WorkflowStepInfo" } } } }, "dbModel.WorkflowStepInfo": { "type": "object", "properties": { "isEnd": { "description": "是否是完结流节点", "type": "boolean" }, "isStrat": { "description": "是否是开始流节点", "type": "boolean" }, "stepAuthorityID": { "description": "操作者级别id", "type": "string" }, "stepName": { "description": "工作流名称", "type": "string" }, "stepNo": { "description": "步骤id （第几步）", "type": "number" } } }, "modelInterface.PageInfo": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "name": "x-token", "in": "header" } }}
|
