swag文档默认属性调整

This commit is contained in:
piexlmax(奇淼
2023-12-22 10:27:51 +08:00
parent 0a4cda26cb
commit 22f68fedcb
6 changed files with 311 additions and 447 deletions
+99 -142
View File
@@ -1,10 +1,10 @@
{
"swagger": "2.0",
"info": {
"description": "This is a sample Server pets",
"title": "Swagger Example API",
"description": "使用gin+vue进行极速开发的全栈开发基础平台",
"title": "Gin-Vue-Admin Swagger API接口文档",
"contact": {},
"version": "0.0.1"
"version": "v2.5.7"
},
"paths": {
"/api/createApi": {
@@ -1789,6 +1789,12 @@
],
"summary": "获取单一客户信息",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
@@ -1807,12 +1813,6 @@
"name": "customerPhoneData",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
"name": "id",
"in": "query"
},
{
"type": "integer",
"description": "管理角色ID",
@@ -3114,6 +3114,12 @@
],
"summary": "用id查询SysDictionary",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
@@ -3126,12 +3132,6 @@
"name": "desc",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "字典名(中)",
@@ -3393,6 +3393,12 @@
],
"summary": "用id查询SysDictionaryDetail",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
@@ -3405,12 +3411,6 @@
"name": "extend",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "展示值",
@@ -3492,6 +3492,12 @@
],
"summary": "分页获取SysDictionaryDetail列表",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "创建时间",
@@ -3504,12 +3510,6 @@
"name": "extend",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "关键字",
@@ -3808,6 +3808,12 @@
],
"summary": "用id查询SysOperationRecord",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "代理",
@@ -3832,12 +3838,6 @@
"name": "error_message",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "请求ip",
@@ -3931,6 +3931,12 @@
],
"summary": "分页获取SysOperationRecord列表",
"parameters": [
{
"type": "integer",
"description": "主键ID",
"name": "ID",
"in": "query"
},
{
"type": "string",
"description": "代理",
@@ -3955,12 +3961,6 @@
"name": "error_message",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "请求ip",
@@ -4871,23 +4871,6 @@
}
}
},
"config.Detail": {
"type": "object",
"properties": {
"compareField": {
"description": "需要比较时间的字段",
"type": "string"
},
"interval": {
"description": "时间间隔",
"type": "string"
},
"tableName": {
"description": "需要清理的表名",
"type": "string"
}
}
},
"config.Excel": {
"type": "object",
"properties": {
@@ -5374,9 +5357,6 @@
"tencent-cos": {
"$ref": "#/definitions/config.TencentCOS"
},
"timer": {
"$ref": "#/definitions/config.Timer"
},
"zap": {
"$ref": "#/definitions/config.Zap"
}
@@ -5566,29 +5546,6 @@
}
}
},
"config.Timer": {
"type": "object",
"properties": {
"detail": {
"type": "array",
"items": {
"$ref": "#/definitions/config.Detail"
}
},
"spec": {
"description": "CRON表达式",
"type": "string"
},
"start": {
"description": "是否启用",
"type": "boolean"
},
"with_seconds": {
"description": "是否精确到秒",
"type": "boolean"
}
}
},
"config.Zap": {
"type": "object",
"properties": {
@@ -5633,6 +5590,10 @@
"example.ExaCustomer": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
@@ -5645,10 +5606,6 @@
"description": "客户手机号",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"sysUser": {
"description": "管理详情",
"allOf": [
@@ -5674,6 +5631,10 @@
"example.ExaFile": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"chunkTotal": {
"type": "integer"
},
@@ -5696,10 +5657,6 @@
"filePath": {
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"isFinish": {
"type": "boolean"
},
@@ -5712,6 +5669,10 @@
"example.ExaFileChunk": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
@@ -5725,10 +5686,6 @@
"fileChunkPath": {
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"updatedAt": {
"description": "更新时间",
"type": "string"
@@ -5738,14 +5695,14 @@
"example.ExaFileUploadAndDownload": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"key": {
"description": "编号",
"type": "string"
@@ -6020,6 +5977,10 @@
"request.SearchApiParams": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"apiGroup": {
"description": "api组",
"type": "string"
@@ -6036,10 +5997,6 @@
"description": "api中文描述",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"keyword": {
"description": "关键字",
"type": "string"
@@ -6487,6 +6444,10 @@
"system.SysApi": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"apiGroup": {
"description": "api组",
"type": "string"
@@ -6499,10 +6460,6 @@
"description": "api中文描述",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"method": {
"description": "方法:创建POST(默认)|查看GET|更新PUT|删除DELETE",
"type": "string"
@@ -6570,6 +6527,10 @@
"system.SysAutoCode": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
@@ -6577,10 +6538,6 @@
"desc": {
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"label": {
"type": "string"
},
@@ -6596,6 +6553,10 @@
"system.SysBaseMenu": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"authoritys": {
"type": "array",
"items": {
@@ -6620,10 +6581,6 @@
"description": "是否在列表隐藏",
"type": "boolean"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"menuBtn": {
"type": "array",
"items": {
@@ -6669,6 +6626,10 @@
"system.SysBaseMenuBtn": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
@@ -6676,10 +6637,6 @@
"desc": {
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"name": {
"type": "string"
},
@@ -6695,14 +6652,14 @@
"system.SysBaseMenuParameter": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"key": {
"description": "地址栏携带参数的key",
"type": "string"
@@ -6727,6 +6684,10 @@
"system.SysDictionary": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
@@ -6735,10 +6696,6 @@
"description": "描述",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"name": {
"description": "字典名(中)",
"type": "string"
@@ -6766,6 +6723,10 @@
"system.SysDictionaryDetail": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"createdAt": {
"description": "创建时间",
"type": "string"
@@ -6774,10 +6735,6 @@
"description": "扩展值",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"label": {
"description": "展示值",
"type": "string"
@@ -6807,6 +6764,10 @@
"system.SysMenu": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"authoritys": {
"type": "array",
"items": {
@@ -6837,10 +6798,6 @@
"description": "是否在列表隐藏",
"type": "boolean"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"menuBtn": {
"type": "array",
"items": {
@@ -6889,6 +6846,10 @@
"system.SysOperationRecord": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"agent": {
"description": "代理",
"type": "string"
@@ -6905,10 +6866,6 @@
"description": "错误信息",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"ip": {
"description": "请求ip",
"type": "string"
@@ -6949,6 +6906,10 @@
"system.SysUser": {
"type": "object",
"properties": {
"ID": {
"description": "主键ID",
"type": "integer"
},
"activeColor": {
"description": "活跃颜色",
"type": "string"
@@ -6986,10 +6947,6 @@
"description": "用户头像",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"
},
"nickName": {
"description": "用户昵称",
"type": "string"