apps/x_admin
1
0
Fork 0
mirror of https://gitee.com/xiangheng/x_admin.git synced 2025-12-24 08:12:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

文档优化

Browse Source
This commit is contained in:
xh
2025-11-30 02:44:35 +08:00
parent fd453b3d7f
commit 66bbb4c6bf
11 changed files with 327 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
server/docs/swagger.json
View File

@@ -2,21 +2,28 @@
"swagger": "2.0",
"info": {
"description": "x_admin是一个完整的后台管理系统",
"title": "x_admin文档",
"termsOfService": "http://x.adtk.cn",
"contact": {
"name": "API Support",
"name": "xh",
"url": "http://x.adtk.cn",
"email": "11675084@qq.com"
"email": "x@adtk.cn"
},
"license": {
"name": "MIT License",
"url": "https://gitee.com/xiangheng/x_admin/blob/main/LICENSE"
},
"version": "0.0.1"
}
},
"basePath": "/",
"paths": {
"/api/admin/apiList": {
"get": {
"tags": [
"公共接口"
],
"summary": "获取所有接口",
"responses": {}
}
},
"/api/admin/flow/flow_apply/add": {
"post": {
"produces": [
@@ -2946,7 +2953,20 @@
"in": "query"
}
],
"responses": {}
"responses": {
"200": {
"description": "成功",
"schema": {
"type": "file"
}
},
"500": {
"description": "失败",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/api/admin/user_protocol/ImportFile": {
@@ -2958,7 +2978,30 @@
"user_protocol-用户协议"
],
"summary": "用户协议导入",
"responses": {}
"parameters": [
{
"type": "string",
"description": "token",
"name": "token",
"in": "header",
"required": true
},
{
"type": "file",
"description": "导入文件",
"name": "file",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "成功",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/api/admin/user_protocol/add": {
@@ -3120,7 +3163,7 @@
{
"type": "object",
"properties": {
" data": {
"data": {
"$ref": "#/definitions/schema.UserProtocolResp"
}
}
@@ -3276,7 +3319,7 @@
{
"type": "object",
"properties": {
" data": {
"data": {
"allOf": [
{
"$ref": "#/definitions/response.PageResp"
@@ -3284,7 +3327,7 @@
{
"type": "object",
"properties": {
" lists": {
"lists": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.UserProtocolResp"
@@ -3312,6 +3355,13 @@
],
"summary": "用户协议列表-所有",
"parameters": [
{
"type": "string",
"description": "token",
"name": "token",
"in": "header",
"required": true
},
{
"type": "string",
"description": "标题",
@@ -3366,7 +3416,7 @@
{
"type": "object",
"properties": {
" data": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.UserProtocolResp"
@@ -3380,6 +3430,47 @@
}
}
},
"/api/ws": {
"get": {
"tags": [
"公共接口"
],
"summary": "websocket连接",
"parameters": [
{
"type": "string",
"description": "token",
"name": "token",
"in": "header",
"required": true
},
{
"type": "string",
"description": "用户ID",
"name": "uid",
"in": "query",
"required": true
},
{
"type": "string",
"description": "房间ID",
"name": "room",
"in": "query",
"required": true
}
],
"responses": {}
}
},
"/swagger/doc.json": {
"get": {
"tags": [
"公共接口"
],
"summary": "swagger文档数据",
"responses": {}
}
},
"/system/admin/ListByDeptId/{deptId}": {
"get": {
"description": "获取部门的用户",
@@ -3850,11 +3941,6 @@
}
}
},
"securityDefinitions": {
"BasicAuth": {
"type": "basic"
}
},
"externalDocs": {
"description": "OpenAPI",
"url": "https://swagger.io/resources/open-api/"