feature: swagdoc调整

This commit is contained in:
pixelMax(奇淼
2024-06-21 14:56:55 +08:00
parent d6703e82e2
commit 08606f740d
4 changed files with 1725 additions and 78 deletions

View File

@@ -3450,7 +3450,7 @@ const docTemplate = `{
"in": "query"
},
{
"type": "integer",
"type": "string",
"description": "字典值",
"name": "value",
"in": "query"
@@ -3567,7 +3567,7 @@ const docTemplate = `{
"in": "query"
},
{
"type": "integer",
"type": "string",
"description": "字典值",
"name": "value",
"in": "query"
@@ -3648,6 +3648,400 @@ const docTemplate = `{
}
}
},
"/sysExportTemplate/createSysExportTemplate": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysExportTemplate"
],
"summary": "创建导出模板",
"parameters": [
{
"description": "创建导出模板",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysExportTemplate"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"创建成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/sysExportTemplate/deleteSysExportTemplate": {
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysExportTemplate"
],
"summary": "删除导出模板",
"parameters": [
{
"description": "删除导出模板",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysExportTemplate"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"删除成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/sysExportTemplate/deleteSysExportTemplateByIds": {
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysExportTemplate"
],
"summary": "批量删除导出模板",
"parameters": [
{
"description": "批量删除导出模板",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.IdsReq"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"批量删除成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/sysExportTemplate/exportExcel": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysExportTemplate"
],
"summary": "导出表格模板",
"responses": {}
}
},
"/sysExportTemplate/findSysExportTemplate": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysExportTemplate"
],
"summary": "用id查询导出模板",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "数据库名称",
"name": "dbName",
"in": "query"
},
{
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "模板名称",
"name": "name",
"in": "query"
},
{
"type": "string",
"name": "order",
"in": "query"
},
{
"type": "string",
"description": "表名称",
"name": "tableName",
"in": "query"
},
{
"type": "string",
"description": "模板标识",
"name": "templateID",
"in": "query"
},
{
"type": "string",
"description": "模板信息",
"name": "templateInfo",
"in": "query"
},
{
"type": "string",
"description": "更新时间",
"name": "updatedAt",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"查询成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/sysExportTemplate/getSysExportTemplateList": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysExportTemplate"
],
"summary": "分页获取导出模板列表",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "数据库名称",
"name": "dbName",
"in": "query"
},
{
"type": "string",
"name": "endCreatedAt",
"in": "query"
},
{
"type": "string",
"description": "关键字",
"name": "keyword",
"in": "query"
},
{
"type": "integer",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "模板名称",
"name": "name",
"in": "query"
},
{
"type": "string",
"name": "order",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页大小",
"name": "pageSize",
"in": "query"
},
{
"type": "string",
"name": "startCreatedAt",
"in": "query"
},
{
"type": "string",
"description": "表名称",
"name": "tableName",
"in": "query"
},
{
"type": "string",
"description": "模板标识",
"name": "templateID",
"in": "query"
},
{
"type": "string",
"description": "模板信息",
"name": "templateInfo",
"in": "query"
},
{
"type": "string",
"description": "更新时间",
"name": "updatedAt",
"in": "query"
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/sysExportTemplate/importExcel": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysImportTemplate"
],
"summary": "导入表格",
"responses": {}
}
},
"/sysExportTemplate/updateSysExportTemplate": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SysExportTemplate"
],
"summary": "更新导出模板",
"parameters": [
{
"description": "更新导出模板",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysExportTemplate"
}
}
],
"responses": {
"200": {
"description": "{\"success\":true,\"data\":{},\"msg\":\"更新成功\"}",
"schema": {
"type": "string"
}
}
}
}
},
"/sysOperationRecord/createSysOperationRecord": {
"post": {
"security": [
@@ -4879,6 +5273,14 @@ const docTemplate = `{
}
}
},
"config.DiskList": {
"type": "object",
"properties": {
"mount-point": {
"type": "string"
}
}
},
"config.Excel": {
"type": "object",
"properties": {
@@ -4944,6 +5346,10 @@ const docTemplate = `{
"config.Mongo": {
"type": "object",
"properties": {
"auth-source": {
"description": "验证数据库",
"type": "string"
},
"coll": {
"description": "collection name",
"type": "string"
@@ -5043,12 +5449,15 @@ const docTemplate = `{
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
@@ -5056,7 +5465,7 @@ const docTemplate = `{
"type": "boolean"
},
"username": {
"description": "数据库密码",
"description": "数据库账号",
"type": "string"
}
}
@@ -5098,12 +5507,15 @@ const docTemplate = `{
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
@@ -5111,7 +5523,7 @@ const docTemplate = `{
"type": "boolean"
},
"username": {
"description": "数据库密码",
"description": "数据库账号",
"type": "string"
}
}
@@ -5153,12 +5565,15 @@ const docTemplate = `{
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
@@ -5166,7 +5581,7 @@ const docTemplate = `{
"type": "boolean"
},
"username": {
"description": "数据库密码",
"description": "数据库账号",
"type": "string"
}
}
@@ -5208,12 +5623,15 @@ const docTemplate = `{
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
@@ -5221,7 +5639,7 @@ const docTemplate = `{
"type": "boolean"
},
"username": {
"description": "数据库密码",
"description": "数据库账号",
"type": "string"
}
}
@@ -5266,13 +5684,24 @@ const docTemplate = `{
"description": "服务器地址:端口",
"type": "string"
},
"clusterAddrs": {
"description": "集群模式下的节点地址列表",
"type": "array",
"items": {
"type": "string"
}
},
"db": {
"description": "redis的哪个数据库",
"description": "单实例模式下redis的哪个数据库",
"type": "integer"
},
"password": {
"description": "密码",
"type": "string"
},
"useCluster": {
"description": "是否使用集群模式",
"type": "boolean"
}
}
},
@@ -5310,6 +5739,12 @@ const docTemplate = `{
"$ref": "#/definitions/config.SpecializedDB"
}
},
"disk-list": {
"type": "array",
"items": {
"$ref": "#/definitions/config.DiskList"
}
},
"email": {
"$ref": "#/definitions/github_com_flipped-aurora_gin-vue-admin_server_config.Email"
},
@@ -5413,12 +5848,15 @@ const docTemplate = `{
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
@@ -5429,7 +5867,7 @@ const docTemplate = `{
"type": "string"
},
"username": {
"description": "数据库密码",
"description": "数据库账号",
"type": "string"
}
}
@@ -5471,12 +5909,15 @@ const docTemplate = `{
"type": "string"
},
"path": {
"description": "数据库地址",
"type": "string"
},
"port": {
"description": "数据库端口",
"type": "string"
},
"prefix": {
"description": "数据库前缀",
"type": "string"
},
"singular": {
@@ -5484,7 +5925,7 @@ const docTemplate = `{
"type": "boolean"
},
"username": {
"description": "数据库密码",
"description": "数据库账号",
"type": "string"
}
}
@@ -5500,10 +5941,6 @@ const docTemplate = `{
"description": "数据库类型:mysql(默认)|sqlite|sqlserver|postgresql",
"type": "string"
},
"env": {
"description": "环境值",
"type": "string"
},
"iplimit-count": {
"type": "integer"
},
@@ -5518,7 +5955,7 @@ const docTemplate = `{
"type": "string"
},
"use-mongo": {
"description": "使用redis",
"description": "使用mongo",
"type": "boolean"
},
"use-multipoint": {
@@ -5577,14 +6014,14 @@ const docTemplate = `{
"description": "输出控制台",
"type": "boolean"
},
"max-age": {
"description": "日志留存时间",
"type": "integer"
},
"prefix": {
"description": "日志前缀",
"type": "string"
},
"retention-day": {
"description": "日志保留天数",
"type": "integer"
},
"show-line": {
"description": "显示行",
"type": "boolean"
@@ -5857,9 +6294,13 @@ const docTemplate = `{
"request.InitDB": {
"type": "object",
"required": [
"adminPassword",
"dbName"
],
"properties": {
"adminPassword": {
"type": "string"
},
"dbName": {
"description": "数据库名",
"type": "string"
@@ -5972,6 +6413,14 @@ const docTemplate = `{
"request.RollBack": {
"type": "object",
"properties": {
"deleteApi": {
"description": "是否删除接口",
"type": "boolean"
},
"deleteMenu": {
"description": "是否删除菜单",
"type": "boolean"
},
"deleteTable": {
"description": "是否删除表",
"type": "boolean"
@@ -6318,12 +6767,16 @@ const docTemplate = `{
"description": "是否自动创建api",
"type": "boolean"
},
"autoCreateMenuToSql": {
"description": "是否自动创建menu",
"type": "boolean"
},
"autoCreateResource": {
"description": "是否自动创建资源标识",
"type": "boolean"
},
"autoMoveFile": {
"description": "是否自动移动文件",
"autoMigrate": {
"description": "是否自动迁移表结构",
"type": "boolean"
},
"businessDB": {
@@ -6340,7 +6793,8 @@ const docTemplate = `{
"$ref": "#/definitions/system.Field"
}
},
"hasTimer": {
"gvaModel": {
"description": "是否使用gva默认Model",
"type": "boolean"
},
"humpPackageName": {
@@ -6354,6 +6808,9 @@ const docTemplate = `{
"description": "文件名称",
"type": "string"
},
"primaryField": {
"$ref": "#/definitions/system.Field"
},
"structName": {
"description": "Struct名称",
"type": "string"
@@ -6364,9 +6821,60 @@ const docTemplate = `{
}
}
},
"system.Condition": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"column": {
"type": "string"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"from": {
"type": "string"
},
"operator": {
"type": "string"
},
"templateID": {
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"system.DataSource": {
"type": "object",
"properties": {
"association": {
"description": "关联关系 1 一对一 2 一对多",
"type": "integer"
},
"label": {
"type": "string"
},
"table": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"system.Field": {
"type": "object",
"properties": {
"checkDataSource": {
"description": "是否检查数据源",
"type": "boolean"
},
"clearable": {
"description": "是否可清空",
"type": "boolean"
@@ -6379,10 +6887,22 @@ const docTemplate = `{
"description": "数据库字段描述",
"type": "string"
},
"dataSource": {
"description": "数据源",
"allOf": [
{
"$ref": "#/definitions/system.DataSource"
}
]
},
"dataTypeLong": {
"description": "数据库字段长度",
"type": "string"
},
"defaultValue": {
"description": "是否必填",
"type": "string"
},
"dictType": {
"description": "字典",
"type": "string"
@@ -6395,6 +6915,10 @@ const docTemplate = `{
"description": "中文名",
"type": "string"
},
"fieldIndexType": {
"description": "索引类型",
"type": "string"
},
"fieldJson": {
"description": "FieldJson",
"type": "string"
@@ -6403,6 +6927,10 @@ const docTemplate = `{
"description": "Field名",
"type": "string"
},
"fieldSearchHide": {
"description": "是否隐藏查询条件",
"type": "boolean"
},
"fieldSearchType": {
"description": "搜索条件",
"type": "string"
@@ -6411,6 +6939,14 @@ const docTemplate = `{
"description": "Field数据类型",
"type": "string"
},
"front": {
"description": "是否前端可见",
"type": "boolean"
},
"primaryKey": {
"description": "是否主键",
"type": "boolean"
},
"require": {
"description": "是否必填",
"type": "boolean"
@@ -6421,6 +6957,35 @@ const docTemplate = `{
}
}
},
"system.JoinTemplate": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"joins": {
"type": "string"
},
"on": {
"type": "string"
},
"table": {
"type": "string"
},
"templateID": {
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
"system.Meta": {
"type": "object",
"properties": {
@@ -6615,7 +7180,7 @@ const docTemplate = `{
},
"parentId": {
"description": "父菜单ID",
"type": "string"
"type": "integer"
},
"path": {
"description": "路由path",
@@ -6765,7 +7330,62 @@ const docTemplate = `{
},
"value": {
"description": "字典值",
"type": "string"
}
}
},
"system.SysExportTemplate": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/definitions/system.Condition"
}
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"dbName": {
"description": "数据库名称",
"type": "string"
},
"joinTemplate": {
"type": "array",
"items": {
"$ref": "#/definitions/system.JoinTemplate"
}
},
"limit": {
"type": "integer"
},
"name": {
"description": "模板名称",
"type": "string"
},
"order": {
"type": "string"
},
"tableName": {
"description": "表名称",
"type": "string"
},
"templateID": {
"description": "模板标识",
"type": "string"
},
"templateInfo": {
"description": "模板信息",
"type": "string"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
}
}
},
@@ -6813,7 +7433,7 @@ const docTemplate = `{
}
},
"menuId": {
"type": "string"
"type": "integer"
},
"meta": {
"description": "附加属性",
@@ -6835,7 +7455,7 @@ const docTemplate = `{
},
"parentId": {
"description": "父菜单ID",
"type": "string"
"type": "integer"
},
"path": {
"description": "路由path",