mirror of
https://github.com/go-admin-team/go-admin.git
synced 2026-09-20 17:57:54 +00:00
docs📝: 修改接口文档
This commit is contained in:
zhangwenjian
+191
-87
@@ -13,16 +13,11 @@
|
||||
"paths": {
|
||||
"/api/v1/app-config": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取系统配置信息，主要注意这里不在验证数据权限",
|
||||
"description": "获取系统配置信息，主要注意这里不在验证权限",
|
||||
"tags": [
|
||||
"配置管理"
|
||||
],
|
||||
"summary": "获取系统前台配置信息，主要注意这里不在验证数据权限",
|
||||
"summary": "获取系统前台配置信息，主要注意这里不在验证权限",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "{\"code\": 200, \"data\": [...]}",
|
||||
@@ -50,11 +45,6 @@
|
||||
},
|
||||
"/api/v1/captcha": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取验证码",
|
||||
"tags": [
|
||||
"登陆"
|
||||
@@ -92,7 +82,7 @@
|
||||
"get": {
|
||||
"description": "数据库表列分页列表 / database table column page list",
|
||||
"tags": [
|
||||
"工具 / Tools"
|
||||
"工具 / 生成工具"
|
||||
],
|
||||
"summary": "分页列表数据 / page list data",
|
||||
"parameters": [
|
||||
@@ -129,7 +119,7 @@
|
||||
"get": {
|
||||
"description": "数据库表分页列表 / database table page list",
|
||||
"tags": [
|
||||
"工具 / Tools"
|
||||
"工具 / 生成工具"
|
||||
],
|
||||
"summary": "分页列表数据 / page list data",
|
||||
"parameters": [
|
||||
@@ -238,6 +228,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "删除数据",
|
||||
"tags": [
|
||||
"部门"
|
||||
@@ -644,6 +639,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "删除数据",
|
||||
"tags": [
|
||||
"字典类型"
|
||||
@@ -898,6 +898,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "删除数据",
|
||||
"tags": [
|
||||
"菜单"
|
||||
@@ -1119,7 +1124,7 @@
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/dto.SysPostControl"
|
||||
"$ref": "#/definitions/dto.SysPostInsertReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
@@ -1133,6 +1138,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "删除数据",
|
||||
"tags": [
|
||||
"岗位"
|
||||
@@ -1140,11 +1150,13 @@
|
||||
"summary": "删除岗位",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "id",
|
||||
"description": "请求参数",
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"required": true
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/dto.SysPostDeleteReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -1163,7 +1175,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/post/": {
|
||||
"/api/v1/post/{id}": {
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
@@ -1185,7 +1197,7 @@
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/dto.SysPostControl"
|
||||
"$ref": "#/definitions/dto.SysPostUpdateReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
@@ -1214,8 +1226,8 @@
|
||||
"parameters": [
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "postId",
|
||||
"name": "postId",
|
||||
"description": "编码",
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
@@ -1232,6 +1244,11 @@
|
||||
},
|
||||
"/api/v1/public/uploadFile": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"consumes": [
|
||||
"multipart/form-data"
|
||||
@@ -1487,6 +1504,11 @@
|
||||
},
|
||||
"/api/v1/server-monitor": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"tags": [
|
||||
"系统信息"
|
||||
@@ -2063,6 +2085,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "登录日志删除",
|
||||
"tags": [
|
||||
"登录日志"
|
||||
@@ -2191,6 +2218,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "删除数据",
|
||||
"tags": [
|
||||
"操作日志"
|
||||
@@ -2275,10 +2307,78 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"用户"
|
||||
],
|
||||
"summary": "创建用户",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "用户数据",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/dto.SysUserControl"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "{\"code\": 200, \"data\": [...]}",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/sys-user/{userId}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"tags": [
|
||||
"用户"
|
||||
],
|
||||
"summary": "获取用户",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "用户编码",
|
||||
"name": "userId",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "{\"code\": 200, \"data\": [...]}",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -2308,6 +2408,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "删除数据",
|
||||
"tags": [
|
||||
"用户"
|
||||
@@ -2344,7 +2449,7 @@
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"工具 - 生成表"
|
||||
"工具 / 生成工具"
|
||||
],
|
||||
"summary": "修改表结构",
|
||||
"parameters": [
|
||||
@@ -2378,7 +2483,7 @@
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"工具 - 生成表"
|
||||
"工具 / 生成工具"
|
||||
],
|
||||
"summary": "添加表结构",
|
||||
"parameters": [
|
||||
@@ -2408,7 +2513,7 @@
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"tags": [
|
||||
"工具 - 生成表"
|
||||
"工具 / 生成工具"
|
||||
],
|
||||
"summary": "获取配置",
|
||||
"parameters": [
|
||||
@@ -2432,7 +2537,7 @@
|
||||
"delete": {
|
||||
"description": "删除表结构",
|
||||
"tags": [
|
||||
"工具 - 生成表"
|
||||
"工具 / 生成工具"
|
||||
],
|
||||
"summary": "删除表结构",
|
||||
"parameters": [
|
||||
@@ -2458,7 +2563,7 @@
|
||||
"get": {
|
||||
"description": "生成表分页列表",
|
||||
"tags": [
|
||||
"工具 - 生成表"
|
||||
"工具 / 生成工具"
|
||||
],
|
||||
"summary": "分页列表数据",
|
||||
"parameters": [
|
||||
@@ -2491,70 +2596,13 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/sysUser": {
|
||||
"/api/v1/user/avatar": {
|
||||
"post": {
|
||||
"description": "获取JSON",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"用户"
|
||||
],
|
||||
"summary": "创建用户",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "用户数据",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/dto.SysUserControl"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "{\"code\": 200, \"data\": [...]}",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/sysUser/{userId}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"tags": [
|
||||
"用户"
|
||||
],
|
||||
"summary": "获取用户",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "用户编码",
|
||||
"name": "userId",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "{\"code\": 200, \"data\": [...]}",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/response.Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/user/avatar": {
|
||||
"post": {
|
||||
"description": "获取JSON",
|
||||
"consumes": [
|
||||
"multipart/form-data"
|
||||
@@ -2606,6 +2654,11 @@
|
||||
},
|
||||
"/api/v1/user/pwd/reset": {
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -2673,6 +2726,11 @@
|
||||
},
|
||||
"/api/v1/user/status": {
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"Bearer": []
|
||||
}
|
||||
],
|
||||
"description": "获取JSON",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -3158,7 +3216,53 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"dto.SysPostControl": {
|
||||
"dto.SysPostDeleteReq": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"createBy": {
|
||||
"type": "integer"
|
||||
},
|
||||
"ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"updateBy": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"dto.SysPostInsertReq": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"createBy": {
|
||||
"type": "integer"
|
||||
},
|
||||
"postCode": {
|
||||
"type": "string"
|
||||
},
|
||||
"postId": {
|
||||
"type": "integer"
|
||||
},
|
||||
"postName": {
|
||||
"type": "string"
|
||||
},
|
||||
"remark": {
|
||||
"type": "string"
|
||||
},
|
||||
"sort": {
|
||||
"type": "integer"
|
||||
},
|
||||
"status": {
|
||||
"type": "integer"
|
||||
},
|
||||
"updateBy": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"dto.SysPostUpdateReq": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"createBy": {
|
||||
|
||||
Reference in New Issue
Block a user