Skip to content

G
gin-vue-admin

HeliosJ / gin-vue-admin
与 Fork 源项目一致

Fork自 FLIPPED-AURORA / gin-vue-admin

通知 4
Star 0
Fork 0
G
gin-vue-admin

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

提交 c23f74ce 编写于 作者: Mr.奇淼（'s avatar Mr.奇淼（
浏览文件
操作

文档修复

上级 885d31a2
展开全部 隐藏空白更改
内联 并排
Showing with 319 addition and 358 deletion
QMPlusServer/docs/docs.go
浏览文件 @ c23f74ce
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2019-11-20 16:59:15.3568689 +0800 CST m=+0.056920101
// 2019-12-13 11:22:41.4366202 +0800 CST m=+0.062830801
package docs
......@@ -90,7 +90,7 @@ var doc = `{
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/dbModel.SysApi"
"$ref": "#/definitions/sysModel.SysApi"
}
}
],
......@@ -209,7 +209,7 @@ var doc = `{
}
}
},
"/api/setAuthAndApi": {
"/api/updataApi": {
"post": {
"security": [
{
......@@ -225,16 +225,16 @@ var doc = `{
"tags": [
"SysApi"
],
"summary": "创建api和角色关系",
"summary": "创建基础api",
"parameters": [
{
"description": "创建api和角色关系",
"description": "创建api",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/api.AuthAndPathIn"
"$ref": "#/definitions/api.CreateApiParams"
}
}
],
......@@ -248,7 +248,7 @@ var doc = `{
}
}
},
"/api/updataApi": {
"/authority/createAuthority": {
"post": {
"security": [
{
......@@ -262,18 +262,18 @@ var doc = `{
"application/json"
],
"tags": [
"SysApi"
"authority"
],
"summary": "创建基础api",
"summary": "创建角色",
"parameters": [
{
"description": "创建api",
"description": "创建角色",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/api.CreateApiParams"
"$ref": "#/definitions/api.CreateAuthorityPatams"
}
}
],
......@@ -287,7 +287,7 @@ var doc = `{
}
}
},
"/authority/createAuthority": {
"/authority/deleteAuthority": {
"post": {
"security": [
{
......@@ -303,16 +303,16 @@ var doc = `{
"tags": [
"authority"
],
"summary": "创建角色",
"summary": "删除角色",
"parameters": [
{
"description": "创建角色",
"description": "删除角色",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/api.CreateAuthorityPatams"
"$ref": "#/definitions/api.DeleteAuthorityPatams"
}
}
],
......@@ -326,7 +326,7 @@ var doc = `{
}
}
},
"/authority/deleteAuthority": {
"/authority/getAuthorityList": {
"post": {
"security": [
{
......@@ -342,16 +342,16 @@ var doc = `{
"tags": [
"authority"
],
"summary": "删除角色",
"summary": "分页获取角色列表",
"parameters": [
{
"description": "删除角色",
"description": "分页获取用户列表",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/api.DeleteAuthorityPatams"
"$ref": "#/definitions/modelInterface.PageInfo"
}
}
],
......@@ -365,38 +365,30 @@ var doc = `{
}
}
},
"/authority/getAuthAndApi": {
"/base/login": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"authority"
"Base"
],
"summary": "获取本角色所有有权限的apiId",
"summary": "用户登录",
"parameters": [
{
"description": "获取本角色所有有权限的apiId",
"description": "用户登录接口",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/api.GetAuthorityId"
"$ref": "#/definitions/api.RegistAndLoginStuct"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"schema": {
"type": "string"
}
......@@ -404,38 +396,30 @@ var doc = `{
}
}
},
"/authority/getAuthorityList": {
"/base/regist": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"authority"
"Base"
],
"summary": "分页获取角色列表",
"summary": "用户注册账号",
"parameters": [
{
"description": "分页获取用户列表",
"description": "用户注册接口",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/modelInterface.PageInfo"
"$ref": "#/definitions/api.RegistAndLoginStuct"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"description": "{\"success\":true,\"data\":{},\"msg\":\"注册成功\"}",
"schema": {
"type": "string"
}
......@@ -443,30 +427,38 @@ var doc = `{
}
}
},
"/base/login": {
"/casbin/casbinPUpdata": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Base"
"casbin"
],
"summary": "用户登录",
"summary": "更改角色api权限",
"parameters": [
{
"description": "用户登录接口",
"description": "更改角色api权限",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/api.RegistAndLoginStuct"
"$ref": "#/definitions/api.CreateAuthorityPatams"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
......@@ -474,30 +466,38 @@ var doc = `{
}
}
},
"/base/regist": {
"/casbin/getPolicyPathByAuthorityId": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Base"
"casbin"
],
"summary": "用户注册账号",
"summary": "获取权限列表",
"parameters": [
{
"description": "用户注册接口",
"description": "获取权限列表",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/api.RegistAndLoginStuct"
"$ref": "#/definitions/api.CreateAuthorityPatams"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"注册成功\"}",
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
......@@ -516,7 +516,7 @@ var doc = `{
"application/json"
],
"tags": [
"FileUploadAndDownload"
"ExaFileUploadAndDownload"
],
"summary": "删除文件",
"parameters": [
......@@ -527,7 +527,7 @@ var doc = `{
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/dbModel.FileUploadAndDownload"
"$ref": "#/definitions/dbModel.ExaFileUploadAndDownload"
}
}
],
......@@ -555,7 +555,7 @@ var doc = `{
"application/json"
],
"tags": [
"FileUploadAndDownload"
"ExaFileUploadAndDownload"
],
"summary": "分页文件列表",
"parameters": [
......@@ -594,7 +594,7 @@ var doc = `{
"application/json"
],
"tags": [
"FileUploadAndDownload"
"ExaFileUploadAndDownload"
],
"summary": "上传文件示例",
"parameters": [
......@@ -641,7 +641,7 @@ var doc = `{
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/dbModel.SysBaseMenu"
"$ref": "#/definitions/sysModel.SysBaseMenu"
}
}
],
......@@ -908,7 +908,7 @@ var doc = `{
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/dbModel.SysBaseMenu"
"$ref": "#/definitions/sysModel.SysBaseMenu"
}
}
],
......@@ -933,7 +933,7 @@ var doc = `{
"application/json"
],
"tags": [
"User"
"SysUser"
],
"summary": "用户修改密码",
"parameters": [
......@@ -972,7 +972,7 @@ var doc = `{
"application/json"
],
"tags": [
"User"
"SysUser"
],
"summary": "分页获取用户列表",
"parameters": [
......@@ -1011,7 +1011,7 @@ var doc = `{
"application/json"
],
"tags": [
"User"
"SysUser"
],
"summary": "设置用户权限",
"parameters": [
......@@ -1050,7 +1050,7 @@ var doc = `{
"application/json"
],
"tags": [
"User"
"SysUser"
],
"summary": "用户上传头像",
"parameters": [
......@@ -1096,7 +1096,7 @@ var doc = `{
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/dbModel.Workflow"
"$ref": "#/definitions/sysModel.SysWorkflow"
}
}
],
......@@ -1121,22 +1121,8 @@ var doc = `{
"menus": {
"type": "array",
"items": {
"$ref": "#/definitions/dbModel.SysBaseMenu"
}
}
}
},
"api.AuthAndPathIn": {
"type": "object",
"properties": {
"apiIds": {
"type": "array",
"items": {
"type": "integer"
"$ref": "#/definitions/sysModel.SysBaseMenu"
}
},
"authorityId": {
"type": "string"
}
}
},
......@@ -1192,14 +1178,6 @@ var doc = `{
}
}
},
"api.GetAuthorityId": {
"type": "object",
"properties": {
"authorityId": {
"type": "string"
}
}
},
"api.GetById": {
"type": "object",
"properties": {
......@@ -1238,7 +1216,35 @@ var doc = `{
}
}
},
"dbModel.SysApi": {
"dbModel.ExaFileUploadAndDownload": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"modelInterface.PageInfo": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"pageSize": {
"type": "integer"
}
}
},
"sysModel.SysApi": {
"type": "object",
"properties": {
"description": {
......@@ -1252,13 +1258,13 @@ var doc = `{
}
}
},
"dbModel.SysBaseMenu": {
"sysModel.SysBaseMenu": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/dbModel.SysBaseMenu"
"$ref": "#/definitions/sysModel.SysBaseMenu"
}
},
"component": {
......@@ -1282,29 +1288,15 @@ var doc = `{
"path": {
"type": "string"
},
"title": {
"type": "string"
}
}
},
"dbModel.FileUploadAndDownload": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"sort": {
"type": "string"
},
"tag": {
"type": "string"
},
"url": {
"title": {
"type": "string"
}
}
},
"dbModel.Workflow": {
"sysModel.SysWorkflow": {
"type": "object",
"properties": {
"workflowDescription": {
......@@ -1323,12 +1315,12 @@ var doc = `{
"description": "工作流步骤",
"type": "array",
"items": {
"$ref": "#/definitions/dbModel.WorkflowStepInfo"
"$ref": "#/definitions/sysModel.SysWorkflowStepInfo"
}
}
}
},
"dbModel.WorkflowStepInfo": {
"sysModel.SysWorkflowStepInfo": {
"type": "object",
"properties": {
"isEnd": {
......@@ -1350,16 +1342,9 @@ var doc = `{
"stepNo": {
"description": "步骤id （第几步）",
"type": "number"
}
}
},
"modelInterface.PageInfo": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"pageSize": {
"workflowID": {
"description": "所属工作流ID",
"type": "integer"
}
}
......
QMPlusServer/docs/swagger.json
浏览文件 @ c23f74ce
此差异已折叠。
QMPlusServer/docs/swagger.yaml
浏览文件 @ c23f74ce
......@@ -6,18 +6,9 @@ definitions:
type: string
menus:
items:
$ref: '#/definitions/dbModel.BaseMenu'
$ref: '#/definitions/sysModel.SysBaseMenu'
type: array
type: object
api.AuthAndPathIn:
properties:
apiIds:
items:
type: integer
type: array
authorityId:
type: string
type: object
api.AuthorityIdInfo:
properties:
authorityId:
......@@ -51,11 +42,6 @@ definitions:
authorityId:
type: integer
type: object
api.GetAuthorityId:
properties:
authorityId:
type: string
type: object
api.GetById:
properties:
id:
......@@ -80,7 +66,25 @@ definitions:
uuid:
type: string
type: object
dbModel.Api:
dbModel.ExaFileUploadAndDownload:
properties:
key:
type: string
name:
type: string
tag:
type: string
url:
type: string
type: object
modelInterface.PageInfo:
properties:
page:
type: integer
pageSize:
type: integer
type: object
sysModel.SysApi:
properties:
description:
type: string
......@@ -89,11 +93,11 @@ definitions:
path:
type: string
type: object
dbModel.BaseMenu:
sysModel.SysBaseMenu:
properties:
children:
items:
$ref: '#/definitions/dbModel.BaseMenu'
$ref: '#/definitions/sysModel.SysBaseMenu'
type: array
component:
type: string
......@@ -109,21 +113,12 @@ definitions:
type: string
path:
type: string
title:
type: string
type: object
dbModel.FileUploadAndDownload:
properties:
key:
type: string
name:
type: string
tag:
sort:
type: string
url:
title:
type: string
type: object
dbModel.Workflow:
sysModel.SysWorkflow:
properties:
workflowDescription:
description: 工作流描述
......@@ -137,10 +132,10 @@ definitions:
workflowStep:
description: 工作流步骤
items:
$ref: '#/definitions/dbModel.WorkflowStepInfo'
$ref: '#/definitions/sysModel.SysWorkflowStepInfo'
type: array
type: object
dbModel.WorkflowStepInfo:
sysModel.SysWorkflowStepInfo:
properties:
isEnd:
description: 是否是完结流节点
......@@ -157,12 +152,8 @@ definitions:
stepNo:
description: 步骤id （第几步）
type: number
type: object
modelInterface.PageInfo:
properties:
page:
type: integer
pageSize:
workflowID:
description: 所属工作流ID
type: integer
type: object
info:
......@@ -195,7 +186,7 @@ paths:
- ApiKeyAuth: []
summary: 创建基础api
tags:
- Api
- SysApi
/api/deleteApi:
post:
consumes:
......@@ -206,7 +197,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/dbModel.Api'
$ref: '#/definitions/sysModel.SysApi'
type: object
produces:
- application/json
......@@ -219,7 +210,7 @@ paths:
- ApiKeyAuth: []
summary: 删除指定api
tags:
- Api
- SysApi
/api/getAllApis:
post:
consumes:
......@@ -235,7 +226,7 @@ paths:
- ApiKeyAuth: []
summary: 获取所有的Api 不分页
tags:
- Api
- SysApi
/api/getApiById:
post:
consumes:
......@@ -259,7 +250,7 @@ paths:
- ApiKeyAuth: []
summary: 根据id获取api
tags:
- Api
- SysApi
/api/getApiList:
post:
consumes:
......@@ -283,31 +274,7 @@ paths:
- ApiKeyAuth: []
summary: 分页获取API列表
tags:
- Api
/api/setAuthAndApi:
post:
consumes:
- application/json
parameters:
- description: 创建api和角色关系
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.AuthAndPathIn'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 创建api和角色关系
tags:
- Api
- SysApi
/api/updataApi:
post:
consumes:
......@@ -331,7 +298,7 @@ paths:
- ApiKeyAuth: []
summary: 创建基础api
tags:
- Api
- SysApi
/authority/createAuthority:
post:
consumes:
......@@ -380,30 +347,6 @@ paths:
summary: 删除角色
tags:
- authority
/authority/getAuthAndApi:
post:
consumes:
- application/json
parameters:
- description: 获取本角色所有有权限的apiId
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.GetAuthorityId'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取本角色所有有权限的apiId
tags:
- authority
/authority/getAuthorityList:
post:
consumes:
......@@ -468,6 +411,54 @@ paths:
summary: 用户注册账号
tags:
- Base
/casbin/casbinPUpdata:
post:
consumes:
- application/json
parameters:
- description: 更改角色api权限
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateAuthorityPatams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 更改角色api权限
tags:
- casbin
/casbin/getPolicyPathByAuthorityId:
post:
consumes:
- application/json
parameters:
- description: 获取权限列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.CreateAuthorityPatams'
type: object
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取权限列表
tags:
- casbin
/fileUploadAndDownload/deleteFile:
post:
parameters:
......@@ -476,7 +467,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/dbModel.FileUploadAndDownload'
$ref: '#/definitions/dbModel.ExaFileUploadAndDownload'
type: object
produces:
- application/json
......@@ -489,7 +480,7 @@ paths:
- ApiKeyAuth: []
summary: 删除文件
tags:
- FileUploadAndDownload
- ExaFileUploadAndDownload
/fileUploadAndDownload/getFileList:
post:
consumes:
......@@ -513,7 +504,7 @@ paths:
- ApiKeyAuth: []
summary: 分页文件列表
tags:
- FileUploadAndDownload
- ExaFileUploadAndDownload
/fileUploadAndDownload/upload:
post:
consumes:
......@@ -535,7 +526,7 @@ paths:
- ApiKeyAuth: []
summary: 上传文件示例
tags:
- FileUploadAndDownload
- ExaFileUploadAndDownload
/menu/addBaseMenu:
post:
consumes:
......@@ -546,7 +537,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/dbModel.BaseMenu'
$ref: '#/definitions/sysModel.SysBaseMenu'
type: object
produces:
- application/json
......@@ -710,7 +701,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/dbModel.BaseMenu'
$ref: '#/definitions/sysModel.SysBaseMenu'
type: object
produces:
- application/json
......@@ -745,7 +736,7 @@ paths:
- ApiKeyAuth: []
summary: 用户修改密码
tags:
- User
- SysUser
/user/getUserList:
post:
consumes:
......@@ -769,7 +760,7 @@ paths:
- ApiKeyAuth: []
summary: 分页获取用户列表
tags:
- User
- SysUser
/user/setUserAuthority:
post:
consumes:
......@@ -793,7 +784,7 @@ paths:
- ApiKeyAuth: []
summary: 设置用户权限
tags:
- User
- SysUser
/user/uploadHeaderImg:
post:
consumes:
......@@ -820,7 +811,7 @@ paths:
- ApiKeyAuth: []
summary: 用户上传头像
tags:
- User
- SysUser
/workflow/createWorkFlow:
post:
parameters:
......@@ -829,7 +820,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/dbModel.Workflow'
$ref: '#/definitions/sysModel.SysWorkflow'
type: object
produces:
- application/json
......
README.md
浏览文件 @ c23f74ce
......@@ -74,7 +74,7 @@
3.go server建议使用goland运行 减少出错可能性
4.前端项目node建议高于V8.6.0
5.到前端项目目录下运行 npm i 安装所需依赖
6.依赖安装完成直接运行 npm run dev即可启动项目
6.依赖安装完成直接运行 npm run serve即可启动项目
7.如果要使用swagger自动化文档 首先需要安装 swagger
````
go get -u github.com/swaggo/swag/cmd/swag
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或