调整swag

This commit is contained in:
piexlMax(奇淼
2023-12-01 14:42:54 +08:00
parent 6f9a83709d
commit 58b063770d
4 changed files with 757 additions and 348 deletions
+282 -163
View File
@@ -902,7 +902,7 @@
}
],
"consumes": [
"multipart/form-data"
"application/json"
],
"produces": [
"application/json"
@@ -910,19 +910,21 @@
"tags": [
"AutoCode"
],
"summary": "安装插件",
"summary": "创建插件模板",
"parameters": [
{
"type": "file",
"description": "this is a test file",
"name": "plug",
"in": "formData",
"required": true
"description": "创建插件模板",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysAutoCode"
}
}
],
"responses": {
"200": {
"description": "安装插件成功",
"description": "创建插件模板成功",
"schema": {
"allOf": [
{
@@ -932,10 +934,8 @@
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
@@ -1369,6 +1369,60 @@
}
}
},
"/autoCode/installPlugin": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"AutoCode"
],
"summary": "安装插件",
"parameters": [
{
"type": "file",
"description": "this is a test file",
"name": "plug",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "安装插件成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/autoCode/preview": {
"post": {
"security": [
@@ -1423,6 +1477,60 @@
}
}
},
"/autoCode/pubPlug": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"AutoCode"
],
"summary": "打包插件",
"parameters": [
{
"description": "打包插件",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/system.SysAutoCode"
}
}
],
"responses": {
"200": {
"description": "打包插件成功",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"msg": {
"type": "string"
}
}
}
]
}
}
}
}
},
"/autoCode/rollback": {
"post": {
"security": [
@@ -3092,68 +3200,6 @@
"SysDictionary"
],
"summary": "分页获取SysDictionary列表",
"parameters": [
{
"type": "string",
"description": "创建时间",
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "描述",
"name": "desc",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "关键字",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "字典名(中)",
"name": "name",
"in": "query"
},
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页大小",
"name": "pageSize",
"in": "query"
},
{
"type": "boolean",
"description": "状态",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "字典名(英)",
"name": "type",
"in": "query"
},
{
"type": "string",
"description": "更新时间",
"name": "updatedAt",
"in": "query"
}
],
"responses": {
"200": {
"description": "分页获取SysDictionary列表,返回包括列表,总数,页码,每页数量",
@@ -3353,6 +3399,12 @@
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "扩展值",
"name": "extend",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
@@ -3446,6 +3498,12 @@
"name": "createdAt",
"in": "query"
},
{
"type": "string",
"description": "扩展值",
"name": "extend",
"in": "query"
},
{
"type": "integer",
"description": "主键ID",
@@ -4892,6 +4950,71 @@
}
}
},
"config.Mongo": {
"type": "object",
"properties": {
"coll": {
"description": "collection name",
"type": "string"
},
"connect-timeout-ms": {
"description": "连接超时时间",
"type": "integer"
},
"database": {
"description": "database name",
"type": "string"
},
"hosts": {
"description": "主机列表",
"type": "array",
"items": {
"$ref": "#/definitions/config.MongoHost"
}
},
"is-zap": {
"description": "是否开启zap日志",
"type": "boolean"
},
"max-pool-size": {
"description": "最大连接池",
"type": "integer"
},
"min-pool-size": {
"description": "最小连接池",
"type": "integer"
},
"options": {
"description": "mongodb options",
"type": "string"
},
"password": {
"description": "密码",
"type": "string"
},
"socket-timeout-ms": {
"description": "socket超时时间",
"type": "integer"
},
"username": {
"description": "用户名",
"type": "string"
}
}
},
"config.MongoHost": {
"type": "object",
"properties": {
"host": {
"description": "ip地址",
"type": "string"
},
"port": {
"description": "端口",
"type": "string"
}
}
},
"config.Mssql": {
"type": "object",
"properties": {
@@ -4929,15 +5052,12 @@
"type": "string"
},
"path": {
"description": "服务器地址:端口",
"type": "string"
},
"port": {
"description": ":端口",
"type": "string"
},
"prefix": {
"description": "全局表前缀,单独定义TableName则不生效",
"type": "string"
},
"singular": {
@@ -4945,7 +5065,7 @@
"type": "boolean"
},
"username": {
"description": "数据库用户名",
"description": "数据库密码",
"type": "string"
}
}
@@ -4987,15 +5107,12 @@
"type": "string"
},
"path": {
"description": "服务器地址:端口",
"type": "string"
},
"port": {
"description": ":端口",
"type": "string"
},
"prefix": {
"description": "全局表前缀,单独定义TableName则不生效",
"type": "string"
},
"singular": {
@@ -5003,7 +5120,7 @@
"type": "boolean"
},
"username": {
"description": "数据库用户名",
"description": "数据库密码",
"type": "string"
}
}
@@ -5045,15 +5162,12 @@
"type": "string"
},
"path": {
"description": "服务器地址:端口",
"type": "string"
},
"port": {
"description": ":端口",
"type": "string"
},
"prefix": {
"description": "全局表前缀,单独定义TableName则不生效",
"type": "string"
},
"singular": {
@@ -5061,7 +5175,7 @@
"type": "boolean"
},
"username": {
"description": "数据库用户名",
"description": "数据库密码",
"type": "string"
}
}
@@ -5103,15 +5217,12 @@
"type": "string"
},
"path": {
"description": "服务器地址:端口",
"type": "string"
},
"port": {
"description": ":端口",
"type": "string"
},
"prefix": {
"description": "全局表前缀,单独定义TableName则不生效",
"type": "string"
},
"singular": {
@@ -5119,66 +5230,8 @@
"type": "boolean"
},
"username": {
"description": "数据库用户名",
"type": "string"
}
}
},
"config.Sqlite": {
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"engine": {
"description": "数据库引擎,默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"description": "服务器地址:端口",
"type": "string"
},
"port": {
"description": ":端口",
"type": "string"
},
"prefix": {
"description": "全局表前缀,单独定义TableName则不生效",
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数,true表示开启",
"type": "boolean"
},
"username": {
"description": "数据库用户名",
"type": "string"
}
}
},
@@ -5286,6 +5339,9 @@
}
]
},
"mongo": {
"$ref": "#/definitions/config.Mongo"
},
"mssql": {
"$ref": "#/definitions/config.Mssql"
},
@@ -5303,15 +5359,15 @@
"pgsql": {
"$ref": "#/definitions/config.Pgsql"
},
"sqlite": {
"$ref": "#/definitions/config.Sqlite"
},
"qiniu": {
"$ref": "#/definitions/config.Qiniu"
},
"redis": {
"$ref": "#/definitions/config.Redis"
},
"sqlite": {
"$ref": "#/definitions/config.Sqlite"
},
"system": {
"$ref": "#/definitions/config.System"
},
@@ -5369,15 +5425,12 @@
"type": "string"
},
"path": {
"description": "服务器地址:端口",
"type": "string"
},
"port": {
"description": ":端口",
"type": "string"
},
"prefix": {
"description": "全局表前缀,单独定义TableName则不生效",
"type": "string"
},
"singular": {
@@ -5388,7 +5441,62 @@
"type": "string"
},
"username": {
"description": "数据库用户名",
"description": "数据库密码",
"type": "string"
}
}
},
"config.Sqlite": {
"type": "object",
"properties": {
"config": {
"description": "高级配置",
"type": "string"
},
"db-name": {
"description": "数据库名",
"type": "string"
},
"engine": {
"description": "数据库引擎,默认InnoDB",
"type": "string",
"default": "InnoDB"
},
"log-mode": {
"description": "是否开启Gorm全局日志",
"type": "string"
},
"log-zap": {
"description": "是否通过zap写入日志文件",
"type": "boolean"
},
"max-idle-conns": {
"description": "空闲中的最大连接数",
"type": "integer"
},
"max-open-conns": {
"description": "打开到数据库的最大连接数",
"type": "integer"
},
"password": {
"description": "数据库密码",
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "string"
},
"prefix": {
"type": "string"
},
"singular": {
"description": "是否开启全局禁用复数,true表示开启",
"type": "boolean"
},
"username": {
"description": "数据库密码",
"type": "string"
}
}
@@ -5421,6 +5529,10 @@
"router-prefix": {
"type": "string"
},
"use-mongo": {
"description": "使用redis",
"type": "boolean"
},
"use-multipoint": {
"description": "多点登录拦截",
"type": "boolean"
@@ -5660,31 +5772,31 @@
"type": "object",
"properties": {
"from": {
"description": "件人",
"description": "件人 你自己要发邮件的邮箱",
"type": "string"
},
"host": {
"description": "服务器地址",
"description": "服务器地址 例如 smtp.qq.com 请前往QQ或者你要发邮件的邮箱查看其smtp协议",
"type": "string"
},
"is-ssl": {
"description": "是否SSL",
"description": "是否SSL 是否开启SSL",
"type": "boolean"
},
"nickname": {
"description": "昵称",
"description": "昵称 发件人昵称 通常为自己的邮箱",
"type": "string"
},
"port": {
"description": "端口",
"description": "端口 请前往QQ或者你要发邮件的邮箱查看其smtp协议 大多为 465",
"type": "integer"
},
"secret": {
"description": "密钥",
"description": "密钥 用于登录的密钥 最好不要用邮箱密码 去邮箱smtp申请一个用于登录的密钥",
"type": "string"
},
"to": {
"description": "收件人:多个以英文逗号分隔",
"description": "收件人:多个以英文逗号分隔 例:a@qq.com b@qq.com 正式开发中请把此项目作为参数使用",
"type": "string"
}
}
@@ -5780,14 +5892,17 @@
"request.InitDB": {
"type": "object",
"required": [
"dbName",
"userName"
"dbName"
],
"properties": {
"dbName": {
"description": "数据库名",
"type": "string"
},
"dbPath": {
"description": "sqlite数据库文件路径",
"type": "string"
},
"dbType": {
"description": "数据库类型",
"type": "string"
@@ -6655,6 +6770,10 @@
"description": "创建时间",
"type": "string"
},
"extend": {
"description": "扩展值",
"type": "string"
},
"id": {
"description": "主键ID",
"type": "integer"