refactor🎨:接口文档重新生成

This commit is contained in:
zhangwenjian committed 2021-06-25 11:33:55 +08:00
1 parent 0f623521c4
commit acdcd0c867
3 files changed
+198 -88

No files matched your search

+76 -33
View File
@@ -65,6 +65,46 @@ var doc = `{
} }
} }
}, },
"/api/v1/captcha": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取验证码",
"tags": [
"登陆"
],
"summary": "获取验证码",
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "string"
},
"id": {
"type": "string"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/v1/db/columns/page": { "/api/v1/db/columns/page": {
"get": { "get": {
"description": "数据库表列分页列表 / database table column page list", "description": "数据库表列分页列表 / database table column page list",
@@ -780,6 +820,9 @@ var doc = `{
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
"tags": [
"登陆"
],
"summary": "登陆", "summary": "登陆",
"parameters": [ "parameters": [
{ {
@@ -2578,8 +2621,39 @@ var doc = `{
} }
} }
}, },
"/api/v1/user/pwd": { "/api/v1/user/pwd/reset": {
"post": { "put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"用户"
],
"summary": "重置用户密码",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.ResetSysUserPwdReq"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/api/v1/user/pwd/set": {
"put": {
"security": [ "security": [
{ {
"Bearer": [] "Bearer": []
@@ -2614,37 +2688,6 @@ var doc = `{
} }
} }
}, },
"/api/v1/user/pwd/reset": {
"put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"用户"
],
"summary": "重置用户密码",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.ResetSysUserPwdReq"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/api/v1/user/status": { "/api/v1/user/status": {
"put": { "put": {
"description": "获取JSON", "description": "获取JSON",
+76 -33
View File
@@ -48,6 +48,46 @@
} }
} }
}, },
"/api/v1/captcha": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取验证码",
"tags": [
"登陆"
],
"summary": "获取验证码",
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "string"
},
"id": {
"type": "string"
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/api/v1/db/columns/page": { "/api/v1/db/columns/page": {
"get": { "get": {
"description": "数据库表列分页列表 / database table column page list", "description": "数据库表列分页列表 / database table column page list",
@@ -763,6 +803,9 @@
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
"tags": [
"登陆"
],
"summary": "登陆", "summary": "登陆",
"parameters": [ "parameters": [
{ {
@@ -2561,8 +2604,39 @@
} }
} }
}, },
"/api/v1/user/pwd": { "/api/v1/user/pwd/reset": {
"post": { "put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"用户"
],
"summary": "重置用户密码",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.ResetSysUserPwdReq"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/api/v1/user/pwd/set": {
"put": {
"security": [ "security": [
{ {
"Bearer": [] "Bearer": []
@@ -2597,37 +2671,6 @@
} }
} }
}, },
"/api/v1/user/pwd/reset": {
"put": {
"description": "获取JSON",
"consumes": [
"application/json"
],
"tags": [
"用户"
],
"summary": "重置用户密码",
"parameters": [
{
"description": "body",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.ResetSysUserPwdReq"
}
}
],
"responses": {
"200": {
"description": "{\"code\": 200, \"data\": [...]}",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/api/v1/user/status": { "/api/v1/user/status": {
"put": { "put": {
"description": "获取JSON", "description": "获取JSON",
+46 -22
View File
@@ -840,6 +840,28 @@ paths:
summary: 获取系统前台配置信息,主要注意这里不在验证数据权限 summary: 获取系统前台配置信息,主要注意这里不在验证数据权限
tags: tags:
- 配置管理 - 配置管理
/api/v1/captcha:
get:
description: 获取验证码
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: string
id:
type: string
msg:
type: string
type: object
security:
- Bearer: []
summary: 获取验证码
tags:
- 登陆
/api/v1/db/columns/page: /api/v1/db/columns/page:
get: get:
description: 数据库表列分页列表 / database table column page list description: 数据库表列分页列表 / database table column page list
@@ -1309,6 +1331,8 @@ paths:
schema: schema:
type: string type: string
summary: 登陆 summary: 登陆
tags:
- 登陆
/api/v1/menu: /api/v1/menu:
delete: delete:
description: 删除数据 description: 删除数据
@@ -2401,28 +2425,6 @@ paths:
summary: 获取个人中心用户 summary: 获取个人中心用户
tags: tags:
- 个人中心 - 个人中心
/api/v1/user/pwd:
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.PassWord'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 重置密码
tags:
- 用户
/api/v1/user/pwd/reset: /api/v1/user/pwd/reset:
put: put:
consumes: consumes:
@@ -2443,6 +2445,28 @@ paths:
summary: 重置用户密码 summary: 重置用户密码
tags: tags:
- 用户 - 用户
/api/v1/user/pwd/set:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.PassWord'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 重置密码
tags:
- 用户
/api/v1/user/status: /api/v1/user/status:
put: put:
consumes: consumes: