From afbf3a281166a1092c598416a84920726c6cc548 Mon Sep 17 00:00:00 2001 From: huangjiajun <582604932@qq.com> Date: Fri, 22 Nov 2024 10:01:54 +0800 Subject: [PATCH] =?UTF-8?q?=E7=9F=AD=E4=BF=A1=E5=8F=91=E9=80=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs.go | 218 +++++++++++++++++++++++++++++++++++++++++++++- docs/swagger.json | 213 +++++++++++++++++++++++++++++++++++++++++++- docs/swagger.yaml | 146 ++++++++++++++++++++++++++++++- 3 files changed, 571 insertions(+), 6 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index cf79609..1595c25 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1,4 +1,5 @@ -// Package docs Code generated by swaggo/swag. DO NOT EDIT +// Code generated by swaggo/swag. DO NOT EDIT. + package docs import "github.com/swaggo/swag" @@ -24,6 +25,44 @@ const docTemplate = `{ "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { + "/api/v1/addFriend/basalRate": { + "get": { + "description": "基础速率(获取)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "添加好友" + ], + "summary": "蛋蛋星球-添加好友-基础速率(获取)", + "parameters": [ + { + "type": "string", + "description": "验证参数Bearer和token空格拼接", + "name": "Authorization", + "in": "header", + "required": true + } + ], + "responses": { + "200": { + "description": "具体数据", + "schema": { + "$ref": "#/definitions/md.BasalRateResp" + } + }, + "400": { + "description": "具体错误", + "schema": { + "$ref": "#/definitions/md.Response" + } + } + } + } + }, "/api/v1/addFriend/eggEnergyDetails": { "post": { "description": "蛋蛋能量明细(获取)", @@ -232,6 +271,44 @@ const docTemplate = `{ } } }, + "/api/v1/addFriend/totalRate": { + "get": { + "description": "总速率(获取)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "添加好友" + ], + "summary": "蛋蛋星球-添加好友-总速率(获取)", + "parameters": [ + { + "type": "string", + "description": "验证参数Bearer和token空格拼接", + "name": "Authorization", + "in": "header", + "required": true + } + ], + "responses": { + "200": { + "description": "具体数据", + "schema": { + "$ref": "#/definitions/md.TotalRateResp" + } + }, + "400": { + "description": "具体错误", + "schema": { + "$ref": "#/definitions/md.Response" + } + } + } + } + }, "/api/v1/comm/getOssUrl": { "get": { "description": "上传许可链接(获取)", @@ -479,7 +556,9 @@ const docTemplate = `{ "name": "req", "in": "body", "required": true, - "schema": {} + "schema": { + "type": "object" + } } ], "responses": { @@ -578,6 +657,46 @@ const docTemplate = `{ } } } + }, + "/v1/smsSend": { + "post": { + "description": "发送短信", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "发送短信" + ], + "summary": "发送短信", + "parameters": [ + { + "description": "注册参数", + "name": "req", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/md.SmsSendReq" + } + } + ], + "responses": { + "200": { + "description": "成功返回", + "schema": { + "type": "string" + } + }, + "400": { + "description": "具体错误", + "schema": { + "$ref": "#/definitions/md.Response" + } + } + } + } } }, "definitions": { @@ -598,6 +717,43 @@ const docTemplate = `{ } } }, + "md.BasalRateResp": { + "type": "object", + "properties": { + "basal_rate": { + "description": "基础速率", + "type": "string" + }, + "consumed_egg_energy": { + "description": "收益蛋蛋能量", + "type": "string" + }, + "consumed_egg_point": { + "description": "消耗蛋蛋积分", + "type": "string" + }, + "consumed_time": { + "description": "消耗时间", + "type": "string" + }, + "estimated_revenue": { + "description": "预估收益", + "type": "string" + }, + "remaining_egg_energy": { + "description": "剩余蛋蛋能量", + "type": "string" + }, + "remaining_time": { + "description": "剩余时间", + "type": "string" + }, + "sign_countdown": { + "description": "收益倒计时", + "type": "string" + } + } + }, "md.EggEnergyDetailReq": { "type": "object", "properties": { @@ -1037,6 +1193,37 @@ const docTemplate = `{ } } }, + "md.SmsSendReq": { + "type": "object", + "required": [ + "mobile" + ], + "properties": { + "captcha_output": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "gen_time": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "lot_number": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "mobile": { + "type": "string" + }, + "pass_token": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "type": { + "type": "string", + "example": "h5Register:h5注册页、wechatBindPhone:微信绑定手机、login:登陆、findPwd:找回密码、changePwd:修改密码" + } + } + }, "md.SpaceListNode": { "type": "object", "properties": { @@ -1054,6 +1241,31 @@ const docTemplate = `{ } } }, + "md.TotalRateResp": { + "type": "object", + "properties": { + "consumed_personal_egg_point": { + "description": "消耗个人蛋蛋积分", + "type": "string" + }, + "consumed_team_egg_point": { + "description": "消耗团队蛋蛋积分", + "type": "string" + }, + "now_basal_rate": { + "description": "当前基础速率/小时", + "type": "string" + }, + "now_team_rate": { + "description": "当前团队速率/小时", + "type": "string" + }, + "now_total_rate": { + "description": "总速率/小时", + "type": "string" + } + } + }, "md.TransferTypeList": { "type": "object", "properties": { @@ -1099,8 +1311,6 @@ var SwaggerInfo = &swag.Spec{ Description: "APP客户端-Api接口", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, - LeftDelim: "{{", - RightDelim: "}}", } func init() { diff --git a/docs/swagger.json b/docs/swagger.json index f8fd500..b5f2a6e 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -18,6 +18,44 @@ "host": "ddxq.izhim.com", "basePath": "/api/v1", "paths": { + "/api/v1/addFriend/basalRate": { + "get": { + "description": "基础速率(获取)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "添加好友" + ], + "summary": "蛋蛋星球-添加好友-基础速率(获取)", + "parameters": [ + { + "type": "string", + "description": "验证参数Bearer和token空格拼接", + "name": "Authorization", + "in": "header", + "required": true + } + ], + "responses": { + "200": { + "description": "具体数据", + "schema": { + "$ref": "#/definitions/md.BasalRateResp" + } + }, + "400": { + "description": "具体错误", + "schema": { + "$ref": "#/definitions/md.Response" + } + } + } + } + }, "/api/v1/addFriend/eggEnergyDetails": { "post": { "description": "蛋蛋能量明细(获取)", @@ -226,6 +264,44 @@ } } }, + "/api/v1/addFriend/totalRate": { + "get": { + "description": "总速率(获取)", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "添加好友" + ], + "summary": "蛋蛋星球-添加好友-总速率(获取)", + "parameters": [ + { + "type": "string", + "description": "验证参数Bearer和token空格拼接", + "name": "Authorization", + "in": "header", + "required": true + } + ], + "responses": { + "200": { + "description": "具体数据", + "schema": { + "$ref": "#/definitions/md.TotalRateResp" + } + }, + "400": { + "description": "具体错误", + "schema": { + "$ref": "#/definitions/md.Response" + } + } + } + } + }, "/api/v1/comm/getOssUrl": { "get": { "description": "上传许可链接(获取)", @@ -473,7 +549,9 @@ "name": "req", "in": "body", "required": true, - "schema": {} + "schema": { + "type": "object" + } } ], "responses": { @@ -572,6 +650,46 @@ } } } + }, + "/v1/smsSend": { + "post": { + "description": "发送短信", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "发送短信" + ], + "summary": "发送短信", + "parameters": [ + { + "description": "注册参数", + "name": "req", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/md.SmsSendReq" + } + } + ], + "responses": { + "200": { + "description": "成功返回", + "schema": { + "type": "string" + } + }, + "400": { + "description": "具体错误", + "schema": { + "$ref": "#/definitions/md.Response" + } + } + } + } } }, "definitions": { @@ -592,6 +710,43 @@ } } }, + "md.BasalRateResp": { + "type": "object", + "properties": { + "basal_rate": { + "description": "基础速率", + "type": "string" + }, + "consumed_egg_energy": { + "description": "收益蛋蛋能量", + "type": "string" + }, + "consumed_egg_point": { + "description": "消耗蛋蛋积分", + "type": "string" + }, + "consumed_time": { + "description": "消耗时间", + "type": "string" + }, + "estimated_revenue": { + "description": "预估收益", + "type": "string" + }, + "remaining_egg_energy": { + "description": "剩余蛋蛋能量", + "type": "string" + }, + "remaining_time": { + "description": "剩余时间", + "type": "string" + }, + "sign_countdown": { + "description": "收益倒计时", + "type": "string" + } + } + }, "md.EggEnergyDetailReq": { "type": "object", "properties": { @@ -1031,6 +1186,37 @@ } } }, + "md.SmsSendReq": { + "type": "object", + "required": [ + "mobile" + ], + "properties": { + "captcha_output": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "gen_time": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "lot_number": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "mobile": { + "type": "string" + }, + "pass_token": { + "type": "string", + "example": "阿里云图形验证码对应参数" + }, + "type": { + "type": "string", + "example": "h5Register:h5注册页、wechatBindPhone:微信绑定手机、login:登陆、findPwd:找回密码、changePwd:修改密码" + } + } + }, "md.SpaceListNode": { "type": "object", "properties": { @@ -1048,6 +1234,31 @@ } } }, + "md.TotalRateResp": { + "type": "object", + "properties": { + "consumed_personal_egg_point": { + "description": "消耗个人蛋蛋积分", + "type": "string" + }, + "consumed_team_egg_point": { + "description": "消耗团队蛋蛋积分", + "type": "string" + }, + "now_basal_rate": { + "description": "当前基础速率/小时", + "type": "string" + }, + "now_team_rate": { + "description": "当前团队速率/小时", + "type": "string" + }, + "now_total_rate": { + "description": "总速率/小时", + "type": "string" + } + } + }, "md.TransferTypeList": { "type": "object", "properties": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index c99925c..99ee51f 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -12,6 +12,33 @@ definitions: description: 总数据量 type: integer type: object + md.BasalRateResp: + properties: + basal_rate: + description: 基础速率 + type: string + consumed_egg_energy: + description: 收益蛋蛋能量 + type: string + consumed_egg_point: + description: 消耗蛋蛋积分 + type: string + consumed_time: + description: 消耗时间 + type: string + estimated_revenue: + description: 预估收益 + type: string + remaining_egg_energy: + description: 剩余蛋蛋能量 + type: string + remaining_time: + description: 剩余时间 + type: string + sign_countdown: + description: 收益倒计时 + type: string + type: object md.EggEnergyDetailReq: properties: asc: @@ -314,6 +341,28 @@ definitions: example: 具体错误原因 type: string type: object + md.SmsSendReq: + properties: + captcha_output: + example: 阿里云图形验证码对应参数 + type: string + gen_time: + example: 阿里云图形验证码对应参数 + type: string + lot_number: + example: 阿里云图形验证码对应参数 + type: string + mobile: + type: string + pass_token: + example: 阿里云图形验证码对应参数 + type: string + type: + example: h5Register:h5注册页、wechatBindPhone:微信绑定手机、login:登陆、findPwd:找回密码、changePwd:修改密码 + type: string + required: + - mobile + type: object md.SpaceListNode: properties: max_count: @@ -326,6 +375,24 @@ definitions: description: 当前人数 type: string type: object + md.TotalRateResp: + properties: + consumed_personal_egg_point: + description: 消耗个人蛋蛋积分 + type: string + consumed_team_egg_point: + description: 消耗团队蛋蛋积分 + type: string + now_basal_rate: + description: 当前基础速率/小时 + type: string + now_team_rate: + description: 当前团队速率/小时 + type: string + now_total_rate: + description: 总速率/小时 + type: string + type: object md.TransferTypeList: properties: available_integral_list: @@ -358,6 +425,31 @@ info: title: 蛋蛋星球-APP客户端 version: "1.0" paths: + /api/v1/addFriend/basalRate: + get: + consumes: + - application/json + description: 基础速率(获取) + parameters: + - description: 验证参数Bearer和token空格拼接 + in: header + name: Authorization + required: true + type: string + produces: + - application/json + responses: + "200": + description: 具体数据 + schema: + $ref: '#/definitions/md.BasalRateResp' + "400": + description: 具体错误 + schema: + $ref: '#/definitions/md.Response' + summary: 蛋蛋星球-添加好友-基础速率(获取) + tags: + - 添加好友 /api/v1/addFriend/eggEnergyDetails: post: consumes: @@ -495,6 +587,31 @@ paths: summary: 蛋蛋星球-添加好友-粉丝团队-九维空间(获取) tags: - 添加好友 + /api/v1/addFriend/totalRate: + get: + consumes: + - application/json + description: 总速率(获取) + parameters: + - description: 验证参数Bearer和token空格拼接 + in: header + name: Authorization + required: true + type: string + produces: + - application/json + responses: + "200": + description: 具体数据 + schema: + $ref: '#/definitions/md.TotalRateResp' + "400": + description: 具体错误 + schema: + $ref: '#/definitions/md.Response' + summary: 蛋蛋星球-添加好友-总速率(获取) + tags: + - 添加好友 /api/v1/comm/getOssUrl: get: consumes: @@ -655,7 +772,8 @@ paths: in: body name: req required: true - schema: {} + schema: + type: object produces: - application/json responses: @@ -723,4 +841,30 @@ paths: summary: 注册 tags: - 注册 + /v1/smsSend: + post: + consumes: + - application/json + description: 发送短信 + parameters: + - description: 注册参数 + in: body + name: req + required: true + schema: + $ref: '#/definitions/md.SmsSendReq' + produces: + - application/json + responses: + "200": + description: 成功返回 + schema: + type: string + "400": + description: 具体错误 + schema: + $ref: '#/definitions/md.Response' + summary: 发送短信 + tags: + - 发送短信 swagger: "2.0"