EggPlanet
/
egg_app
3
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

update swag

master
shenjiachi 1 week ago
parent
d40cbde031
commit
d5d3459ecb
3 changed files with 630 additions and 37 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +234
    -13
      docs/docs.go
  2. +234
    -13
      docs/swagger.json
  3. +162
    -11
      docs/swagger.yaml

+ 234
- 13
docs/docs.go View File

@@ -314,7 +314,7 @@ const docTemplate = `{
}, },
"/api/institutionalManagement/eggEnergy/globalData/fundDataList": { "/api/institutionalManagement/eggEnergy/globalData/fundDataList": {
"post": { "post": {
"description": "新增数据列表(获取)",
"description": "平台营收数据(获取)",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -324,7 +324,7 @@ const docTemplate = `{
"tags": [ "tags": [
"蛋蛋能量" "蛋蛋能量"
], ],
"summary": "制度中心-蛋蛋能量-新增数据列表(获取)",
"summary": "制度中心-蛋蛋能量-平台营收数据(获取)",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -339,7 +339,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/md.GetFundDataListReq"
"$ref": "#/definitions/md.ListPlatformRevenueReq"
} }
} }
], ],
@@ -347,7 +347,7 @@ const docTemplate = `{
"200": { "200": {
"description": "具体数据", "description": "具体数据",
"schema": { "schema": {
"$ref": "#/definitions/md.GetFundDataListResp"
"$ref": "#/definitions/md.ListPlatformRevenueResp"
} }
}, },
"400": { "400": {
@@ -450,6 +450,100 @@ const docTemplate = `{
} }
} }
}, },
"/api/institutionalManagement/eggEnergy/platformRevenue/PlatformRevenueAdd": {
"post": {
"description": "平台营收数据(新增)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"蛋蛋能量"
],
"summary": "制度中心-蛋蛋能量-平台营收数据(新增)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "数据种类、金额、时长(最长24h)、执行次数必填,备注选填",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.AddPlatformRevenueReq"
}
}
],
"responses": {
"200": {
"description": "插入数据 id",
"schema": {
"type": "int"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/institutionalManagement/eggEnergy/platformRevenue/SetVideoReward": {
"post": {
"description": "激励视频(设置)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"蛋蛋能量"
],
"summary": "制度中心-蛋蛋能量-激励视频(设置)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "落地页不填页大小默认20条数据",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.SetVideoRewardReq"
}
}
],
"responses": {
"200": {
"description": "success",
"schema": {
"type": "string"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/institutionalManagement/eggEnergy/updateBasic": { "/api/institutionalManagement/eggEnergy/updateBasic": {
"post": { "post": {
"description": "基础设置(更新)", "description": "基础设置(更新)",
@@ -1489,6 +1583,10 @@ const docTemplate = `{
"md.AddFundDataReq": { "md.AddFundDataReq": {
"type": "object", "type": "object",
"properties": { "properties": {
"frequency": {
"description": "频率(分钟)",
"type": "integer"
},
"hours": { "hours": {
"description": "时长(小时)", "description": "时长(小时)",
"type": "integer" "type": "integer"
@@ -1501,10 +1599,31 @@ const docTemplate = `{
"type": "string", "type": "string",
"example": "备注" "example": "备注"
}, },
"times": {
"description": "剩余执行次数",
"total_amount": {
"description": "金额",
"type": "string"
}
}
},
"md.AddPlatformRevenueReq": {
"type": "object",
"properties": {
"frequency": {
"description": "频率(分钟)",
"type": "integer" "type": "integer"
}, },
"hours": {
"description": "时长(小时)",
"type": "integer"
},
"kind": {
"description": "种类(1:开屏广告 2:banner 广告 3:信息流广告 4：插屏广告)",
"type": "integer"
},
"memo": {
"type": "string",
"example": "备注"
},
"total_amount": { "total_amount": {
"description": "金额", "description": "金额",
"type": "string" "type": "string"
@@ -2068,6 +2187,10 @@ const docTemplate = `{
"type": "string", "type": "string",
"example": "oss存储桶名称" "example": "oss存储桶名称"
}, },
"oss_bucket_scheme": {
"type": "string",
"example": "oss上传方式"
},
"oss_endpoint": { "oss_endpoint": {
"type": "string", "type": "string",
"example": "oss地域节点" "example": "oss地域节点"
@@ -2075,10 +2198,6 @@ const docTemplate = `{
"oss_object_domain": { "oss_object_domain": {
"type": "string", "type": "string",
"example": "oss域名" "example": "oss域名"
},
"oss_object_scheme": {
"type": "string",
"example": "oss上传方式"
} }
} }
}, },
@@ -2548,6 +2667,59 @@ const docTemplate = `{
} }
} }
}, },
"md.ListPlatformRevenueReq": {
"type": "object",
"properties": {
"end_at": {
"type": "string",
"example": "结束时间"
},
"kind": {
"description": "数据类型",
"type": "integer"
},
"limit": {
"description": "每页大小",
"type": "integer"
},
"page": {
"description": "页数",
"type": "integer"
},
"start_at": {
"type": "string",
"example": "开始时间"
}
}
},
"md.ListPlatformRevenueResp": {
"type": "object",
"properties": {
"kind_list": {
"description": "类型列表",
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"list": {
"description": "数据列表",
"type": "array",
"items": {
"$ref": "#/definitions/md.PlatformRevenueDataNode"
}
},
"paginate": {
"description": "分页数据",
"allOf": [
{
"$ref": "#/definitions/applet_app_md_institutional_management_egg_energy.Paginate"
}
]
}
}
},
"md.LoginReq": { "md.LoginReq": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -2594,6 +2766,42 @@ const docTemplate = `{
} }
} }
}, },
"md.PlatformRevenueDataNode": {
"type": "object",
"properties": {
"balance_amount": {
"description": "余额",
"type": "string"
},
"balance_times": {
"description": "剩余执行次数",
"type": "integer"
},
"create_at": {
"description": "创建时间",
"type": "string"
},
"hours": {
"description": "时长",
"type": "integer"
},
"kind": {
"description": "种类(1:开屏广告 2:banner 广告 3:信息流广告 4：插屏广告)",
"type": "integer"
},
"memo": {
"description": "备注",
"type": "string"
},
"system_id": {
"type": "integer"
},
"total_amount": {
"description": "金额",
"type": "string"
}
}
},
"md.PriceSettingStruct": { "md.PriceSettingStruct": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -2677,6 +2885,10 @@ const docTemplate = `{
"type": "string", "type": "string",
"example": "oss存储桶名称" "example": "oss存储桶名称"
}, },
"oss_bucket_scheme": {
"type": "string",
"example": "oss上传方式"
},
"oss_endpoint": { "oss_endpoint": {
"type": "string", "type": "string",
"example": "oss地域节点" "example": "oss地域节点"
@@ -2684,10 +2896,19 @@ const docTemplate = `{
"oss_object_domain": { "oss_object_domain": {
"type": "string", "type": "string",
"example": "oss域名" "example": "oss域名"
}
}
},
"md.SetVideoRewardReq": {
"type": "object",
"properties": {
"ecmp": {
"description": "当前 Ecmp 值",
"type": "string"
}, },
"oss_object_scheme": {
"type": "string",
"example": "oss上传方式"
"unit_price": {
"description": "单价",
"type": "string"
} }
} }
}, },


+ 234
- 13
docs/swagger.json View File

@@ -307,7 +307,7 @@
}, },
"/api/institutionalManagement/eggEnergy/globalData/fundDataList": { "/api/institutionalManagement/eggEnergy/globalData/fundDataList": {
"post": { "post": {
"description": "新增数据列表(获取)",
"description": "平台营收数据(获取)",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -317,7 +317,7 @@
"tags": [ "tags": [
"蛋蛋能量" "蛋蛋能量"
], ],
"summary": "制度中心-蛋蛋能量-新增数据列表(获取)",
"summary": "制度中心-蛋蛋能量-平台营收数据(获取)",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -332,7 +332,7 @@
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/md.GetFundDataListReq"
"$ref": "#/definitions/md.ListPlatformRevenueReq"
} }
} }
], ],
@@ -340,7 +340,7 @@
"200": { "200": {
"description": "具体数据", "description": "具体数据",
"schema": { "schema": {
"$ref": "#/definitions/md.GetFundDataListResp"
"$ref": "#/definitions/md.ListPlatformRevenueResp"
} }
}, },
"400": { "400": {
@@ -443,6 +443,100 @@
} }
} }
}, },
"/api/institutionalManagement/eggEnergy/platformRevenue/PlatformRevenueAdd": {
"post": {
"description": "平台营收数据(新增)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"蛋蛋能量"
],
"summary": "制度中心-蛋蛋能量-平台营收数据(新增)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "数据种类、金额、时长(最长24h)、执行次数必填,备注选填",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.AddPlatformRevenueReq"
}
}
],
"responses": {
"200": {
"description": "插入数据 id",
"schema": {
"type": "int"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/institutionalManagement/eggEnergy/platformRevenue/SetVideoReward": {
"post": {
"description": "激励视频(设置)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"蛋蛋能量"
],
"summary": "制度中心-蛋蛋能量-激励视频(设置)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "落地页不填页大小默认20条数据",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.SetVideoRewardReq"
}
}
],
"responses": {
"200": {
"description": "success",
"schema": {
"type": "string"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/institutionalManagement/eggEnergy/updateBasic": { "/api/institutionalManagement/eggEnergy/updateBasic": {
"post": { "post": {
"description": "基础设置(更新)", "description": "基础设置(更新)",
@@ -1482,6 +1576,10 @@
"md.AddFundDataReq": { "md.AddFundDataReq": {
"type": "object", "type": "object",
"properties": { "properties": {
"frequency": {
"description": "频率(分钟)",
"type": "integer"
},
"hours": { "hours": {
"description": "时长(小时)", "description": "时长(小时)",
"type": "integer" "type": "integer"
@@ -1494,10 +1592,31 @@
"type": "string", "type": "string",
"example": "备注" "example": "备注"
}, },
"times": {
"description": "剩余执行次数",
"total_amount": {
"description": "金额",
"type": "string"
}
}
},
"md.AddPlatformRevenueReq": {
"type": "object",
"properties": {
"frequency": {
"description": "频率(分钟)",
"type": "integer" "type": "integer"
}, },
"hours": {
"description": "时长(小时)",
"type": "integer"
},
"kind": {
"description": "种类(1:开屏广告 2:banner 广告 3:信息流广告 4：插屏广告)",
"type": "integer"
},
"memo": {
"type": "string",
"example": "备注"
},
"total_amount": { "total_amount": {
"description": "金额", "description": "金额",
"type": "string" "type": "string"
@@ -2061,6 +2180,10 @@
"type": "string", "type": "string",
"example": "oss存储桶名称" "example": "oss存储桶名称"
}, },
"oss_bucket_scheme": {
"type": "string",
"example": "oss上传方式"
},
"oss_endpoint": { "oss_endpoint": {
"type": "string", "type": "string",
"example": "oss地域节点" "example": "oss地域节点"
@@ -2068,10 +2191,6 @@
"oss_object_domain": { "oss_object_domain": {
"type": "string", "type": "string",
"example": "oss域名" "example": "oss域名"
},
"oss_object_scheme": {
"type": "string",
"example": "oss上传方式"
} }
} }
}, },
@@ -2541,6 +2660,59 @@
} }
} }
}, },
"md.ListPlatformRevenueReq": {
"type": "object",
"properties": {
"end_at": {
"type": "string",
"example": "结束时间"
},
"kind": {
"description": "数据类型",
"type": "integer"
},
"limit": {
"description": "每页大小",
"type": "integer"
},
"page": {
"description": "页数",
"type": "integer"
},
"start_at": {
"type": "string",
"example": "开始时间"
}
}
},
"md.ListPlatformRevenueResp": {
"type": "object",
"properties": {
"kind_list": {
"description": "类型列表",
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"list": {
"description": "数据列表",
"type": "array",
"items": {
"$ref": "#/definitions/md.PlatformRevenueDataNode"
}
},
"paginate": {
"description": "分页数据",
"allOf": [
{
"$ref": "#/definitions/applet_app_md_institutional_management_egg_energy.Paginate"
}
]
}
}
},
"md.LoginReq": { "md.LoginReq": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -2587,6 +2759,42 @@
} }
} }
}, },
"md.PlatformRevenueDataNode": {
"type": "object",
"properties": {
"balance_amount": {
"description": "余额",
"type": "string"
},
"balance_times": {
"description": "剩余执行次数",
"type": "integer"
},
"create_at": {
"description": "创建时间",
"type": "string"
},
"hours": {
"description": "时长",
"type": "integer"
},
"kind": {
"description": "种类(1:开屏广告 2:banner 广告 3:信息流广告 4：插屏广告)",
"type": "integer"
},
"memo": {
"description": "备注",
"type": "string"
},
"system_id": {
"type": "integer"
},
"total_amount": {
"description": "金额",
"type": "string"
}
}
},
"md.PriceSettingStruct": { "md.PriceSettingStruct": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -2670,6 +2878,10 @@
"type": "string", "type": "string",
"example": "oss存储桶名称" "example": "oss存储桶名称"
}, },
"oss_bucket_scheme": {
"type": "string",
"example": "oss上传方式"
},
"oss_endpoint": { "oss_endpoint": {
"type": "string", "type": "string",
"example": "oss地域节点" "example": "oss地域节点"
@@ -2677,10 +2889,19 @@
"oss_object_domain": { "oss_object_domain": {
"type": "string", "type": "string",
"example": "oss域名" "example": "oss域名"
}
}
},
"md.SetVideoRewardReq": {
"type": "object",
"properties": {
"ecmp": {
"description": "当前 Ecmp 值",
"type": "string"
}, },
"oss_object_scheme": {
"type": "string",
"example": "oss上传方式"
"unit_price": {
"description": "单价",
"type": "string"
} }
} }
}, },


+ 162
- 11
docs/swagger.yaml View File

@@ -111,6 +111,9 @@ definitions:
type: object type: object
md.AddFundDataReq: md.AddFundDataReq:
properties: properties:
frequency:
description: 频率(分钟)
type: integer
hours: hours:
description: 时长(小时) description: 时长(小时)
type: integer type: integer
@@ -120,9 +123,24 @@ definitions:
memo: memo:
example: 备注 example: 备注
type: string type: string
times:
description: 剩余执行次数
total_amount:
description: 金额
type: string
type: object
md.AddPlatformRevenueReq:
properties:
frequency:
description: 频率(分钟)
type: integer type: integer
hours:
description: 时长(小时)
type: integer
kind:
description: 种类(1:开屏广告 2:banner 广告 3:信息流广告 4：插屏广告)
type: integer
memo:
example: 备注
type: string
total_amount: total_amount:
description: 金额 description: 金额
type: string type: string
@@ -516,15 +534,15 @@ definitions:
oss_bucket_name: oss_bucket_name:
example: oss存储桶名称 example: oss存储桶名称
type: string type: string
oss_bucket_scheme:
example: oss上传方式
type: string
oss_endpoint: oss_endpoint:
example: oss地域节点 example: oss地域节点
type: string type: string
oss_object_domain: oss_object_domain:
example: oss域名 example: oss域名
type: string type: string
oss_object_scheme:
example: oss上传方式
type: string
type: object type: object
md.GetEggCoreDataListResp: md.GetEggCoreDataListResp:
properties: properties:
@@ -834,6 +852,42 @@ definitions:
paginate: paginate:
$ref: '#/definitions/applet_app_md_institutional_management_public_platoon.Paginate' $ref: '#/definitions/applet_app_md_institutional_management_public_platoon.Paginate'
type: object type: object
md.ListPlatformRevenueReq:
properties:
end_at:
example: 结束时间
type: string
kind:
description: 数据类型
type: integer
limit:
description: 每页大小
type: integer
page:
description: 页数
type: integer
start_at:
example: 开始时间
type: string
type: object
md.ListPlatformRevenueResp:
properties:
kind_list:
description: 类型列表
items:
additionalProperties: true
type: object
type: array
list:
description: 数据列表
items:
$ref: '#/definitions/md.PlatformRevenueDataNode'
type: array
paginate:
allOf:
- $ref: '#/definitions/applet_app_md_institutional_management_egg_energy.Paginate'
description: 分页数据
type: object
md.LoginReq: md.LoginReq:
properties: properties:
code: code:
@@ -866,6 +920,32 @@ definitions:
description: 奖励系数 description: 奖励系数
type: number type: number
type: object type: object
md.PlatformRevenueDataNode:
properties:
balance_amount:
description: 余额
type: string
balance_times:
description: 剩余执行次数
type: integer
create_at:
description: 创建时间
type: string
hours:
description: 时长
type: integer
kind:
description: 种类(1:开屏广告 2:banner 广告 3:信息流广告 4：插屏广告)
type: integer
memo:
description: 备注
type: string
system_id:
type: integer
total_amount:
description: 金额
type: string
type: object
md.PriceSettingStruct: md.PriceSettingStruct:
properties: properties:
marketplace_merchants_fund_exchange_marketplace_merchants_nums_value: marketplace_merchants_fund_exchange_marketplace_merchants_nums_value:
@@ -924,14 +1004,23 @@ definitions:
oss_bucket_name: oss_bucket_name:
example: oss存储桶名称 example: oss存储桶名称
type: string type: string
oss_bucket_scheme:
example: oss上传方式
type: string
oss_endpoint: oss_endpoint:
example: oss地域节点 example: oss地域节点
type: string type: string
oss_object_domain: oss_object_domain:
example: oss域名 example: oss域名
type: string type: string
oss_object_scheme:
example: oss上传方式
type: object
md.SetVideoRewardReq:
properties:
ecmp:
description: 当前 Ecmp 值
type: string
unit_price:
description: 单价
type: string type: string
type: object type: object
md.SonUserDailyActivityAnalysisNode: md.SonUserDailyActivityAnalysisNode:
@@ -1407,7 +1496,7 @@ paths:
post: post:
consumes: consumes:
- application/json - application/json
description: 新增数据列表(获取)
description: 平台营收数据(获取)
parameters: parameters:
- description: 验证参数Bearer和token空格拼接 - description: 验证参数Bearer和token空格拼接
in: header in: header
@@ -1419,19 +1508,19 @@ paths:
name: req name: req
required: true required: true
schema: schema:
$ref: '#/definitions/md.GetFundDataListReq'
$ref: '#/definitions/md.ListPlatformRevenueReq'
produces: produces:
- application/json - application/json
responses: responses:
"200": "200":
description: 具体数据 description: 具体数据
schema: schema:
$ref: '#/definitions/md.GetFundDataListResp'
$ref: '#/definitions/md.ListPlatformRevenueResp'
"400": "400":
description: 具体错误 description: 具体错误
schema: schema:
$ref: '#/definitions/md.Response' $ref: '#/definitions/md.Response'
summary: 制度中心-蛋蛋能量-新增数据列表(获取)
summary: 制度中心-蛋蛋能量-平台营收数据(获取)
tags: tags:
- 蛋蛋能量 - 蛋蛋能量
/api/institutionalManagement/eggEnergy/globalData/fundDataRecordList: /api/institutionalManagement/eggEnergy/globalData/fundDataRecordList:
@@ -1494,6 +1583,68 @@ paths:
summary: 制度中心-蛋蛋能量-价格趋势(获取) summary: 制度中心-蛋蛋能量-价格趋势(获取)
tags: tags:
- 蛋蛋能量 - 蛋蛋能量
/api/institutionalManagement/eggEnergy/platformRevenue/PlatformRevenueAdd:
post:
consumes:
- application/json
description: 平台营收数据(新增)
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: 数据种类、金额、时长(最长24h)、执行次数必填,备注选填
in: body
name: req
required: true
schema:
$ref: '#/definitions/md.AddPlatformRevenueReq'
produces:
- application/json
responses:
"200":
description: 插入数据 id
schema:
type: int
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 制度中心-蛋蛋能量-平台营收数据(新增)
tags:
- 蛋蛋能量
/api/institutionalManagement/eggEnergy/platformRevenue/SetVideoReward:
post:
consumes:
- application/json
description: 激励视频(设置)
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: 落地页不填页大小默认20条数据
in: body
name: req
required: true
schema:
$ref: '#/definitions/md.SetVideoRewardReq'
produces:
- application/json
responses:
"200":
description: success
schema:
type: string
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 制度中心-蛋蛋能量-激励视频(设置)
tags:
- 蛋蛋能量
/api/institutionalManagement/eggEnergy/updateBasic: /api/institutionalManagement/eggEnergy/updateBasic:
post: post:
consumes: consumes:


Write Preview
Loading…
Cancel
Save