modified 增加结构体描述,完善自动化文档

This commit is contained in:
何秀钢
2021-05-14 11:33:14 +08:00
parent c37ea861eb
commit 0f45d3830a
10 changed files with 69 additions and 39 deletions
+17 -7
View File
@@ -1,6 +1,6 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2021-05-11 17:25:23.4731221 +0800 CST m=+1.258292701
// 2021-05-14 11:28:23.4731221 +0800 CST m=+1.258292701
package docs
@@ -2829,11 +2829,11 @@ var doc = `{
"type": "object",
"properties": {
"imgHeight": {
"description": "图片高度",
"description": "验证码高度",
"type": "integer"
},
"imgWidth": {
"description": "图片宽度",
"description": "验证码宽度",
"type": "integer"
},
"keyLong": {
@@ -2846,7 +2846,7 @@ var doc = `{
"type": "object",
"properties": {
"modelPath": {
"description": "Model路径",
"description": "存放casbin模型的相对路径",
"type": "string"
}
}
@@ -2855,12 +2855,15 @@ var doc = `{
"type": "object",
"properties": {
"compareField": {
"description": "需要比较时间的字段",
"type": "string"
},
"interval": {
"description": "时间间隔",
"type": "string"
},
"tableName": {
"description": "需要清理的表名",
"type": "string"
}
}
@@ -2893,7 +2896,7 @@ var doc = `{
"type": "string"
},
"to": {
"description": "收件人",
"description": "收件人:多个以英文逗号分隔",
"type": "string"
}
}
@@ -2936,6 +2939,7 @@ var doc = `{
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"dbname": {
@@ -2943,15 +2947,18 @@ var doc = `{
"type": "string"
},
"logMode": {
"description": "是否开启Gorm全局日志",
"type": "boolean"
},
"logZap": {
"type": "string"
},
"maxIdleConns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"maxOpenConns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
@@ -2972,7 +2979,7 @@ var doc = `{
"type": "object",
"properties": {
"accessKey": {
"description": "accessKey",
"description": "秘钥AK",
"type": "string"
},
"bucket": {
@@ -2984,7 +2991,7 @@ var doc = `{
"type": "string"
},
"secretKey": {
"description": "secretKey",
"description": "秘钥SK",
"type": "string"
},
"useCdnDomains": {
@@ -3009,6 +3016,7 @@ var doc = `{
"type": "string"
},
"db": {
"description": "redis的哪个数据库",
"type": "integer"
},
"password": {
@@ -3128,9 +3136,11 @@ var doc = `{
}
},
"spec": {
"description": "CRON表达式",
"type": "string"
},
"start": {
"description": "是否启用",
"type": "boolean"
}
}
+16 -6
View File
@@ -2812,11 +2812,11 @@
"type": "object",
"properties": {
"imgHeight": {
"description": "图片高度",
"description": "验证码高度",
"type": "integer"
},
"imgWidth": {
"description": "图片宽度",
"description": "验证码宽度",
"type": "integer"
},
"keyLong": {
@@ -2829,7 +2829,7 @@
"type": "object",
"properties": {
"modelPath": {
"description": "Model路径",
"description": "存放casbin模型的相对路径",
"type": "string"
}
}
@@ -2838,12 +2838,15 @@
"type": "object",
"properties": {
"compareField": {
"description": "需要比较时间的字段",
"type": "string"
},
"interval": {
"description": "时间间隔",
"type": "string"
},
"tableName": {
"description": "需要清理的表名",
"type": "string"
}
}
@@ -2876,7 +2879,7 @@
"type": "string"
},
"to": {
"description": "收件人",
"description": "收件人:多个以英文逗号分隔",
"type": "string"
}
}
@@ -2919,6 +2922,7 @@
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"dbname": {
@@ -2926,15 +2930,18 @@
"type": "string"
},
"logMode": {
"description": "是否开启Gorm全局日志",
"type": "boolean"
},
"logZap": {
"type": "string"
},
"maxIdleConns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"maxOpenConns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
@@ -2955,7 +2962,7 @@
"type": "object",
"properties": {
"accessKey": {
"description": "accessKey",
"description": "秘钥AK",
"type": "string"
},
"bucket": {
@@ -2967,7 +2974,7 @@
"type": "string"
},
"secretKey": {
"description": "secretKey",
"description": "秘钥SK",
"type": "string"
},
"useCdnDomains": {
@@ -2992,6 +2999,7 @@
"type": "string"
},
"db": {
"description": "redis的哪个数据库",
"type": "integer"
},
"password": {
@@ -3111,9 +3119,11 @@
}
},
"spec": {
"description": "CRON表达式",
"type": "string"
},
"start": {
"description": "是否启用",
"type": "boolean"
}
}
+16 -6
View File
@@ -45,10 +45,10 @@ definitions:
config.Captcha:
properties:
imgHeight:
description: 图片高度
description: 验证码高度
type: integer
imgWidth:
description: 图片宽度
description: 验证码宽度
type: integer
keyLong:
description: 验证码长度
@@ -57,16 +57,19 @@ definitions:
config.Casbin:
properties:
modelPath:
description: Model路径
description: 存放casbin模型的相对路径
type: string
type: object
config.Detail:
properties:
compareField:
description: 需要比较时间的字段
type: string
interval:
description: 时间间隔
type: string
tableName:
description: 需要清理的表名
type: string
type: object
config.Email:
@@ -90,7 +93,7 @@ definitions:
description: 密钥
type: string
to:
description: 收件人
description: 收件人:多个以英文逗号分隔
type: string
type: object
config.Excel:
@@ -119,17 +122,21 @@ definitions:
config.Mysql:
properties:
config:
description: 高级配置
type: string
dbname:
description: 数据库名
type: string
logMode:
description: 是否开启Gorm全局日志
type: boolean
logZap:
type: string
maxIdleConns:
description: 空闲中的最大连接数
type: integer
maxOpenConns:
description: 打开到数据库的最大连接数
type: integer
password:
description: 数据库密码
@@ -144,7 +151,7 @@ definitions:
config.Qiniu:
properties:
accessKey:
description: accessKey
description: 秘钥AK
type: string
bucket:
description: 空间名称
@@ -153,7 +160,7 @@ definitions:
description: CDN加速域名
type: string
secretKey:
description: secretKey
description: 秘钥SK
type: string
useCdnDomains:
description: 上传是否使用CDN上传加速
@@ -171,6 +178,7 @@ definitions:
description: 服务器地址:端口
type: string
db:
description: redis的哪个数据库
type: integer
password:
description: 密码
@@ -252,8 +260,10 @@ definitions:
$ref: '#/definitions/config.Detail'
type: array
spec:
description: CRON表达式
type: string
start:
description: 是否启用
type: boolean
type: object
config.Zap: