// Package docs Code generated by swaggo/swag. DO NOT EDIT package docs import "github.com/swaggo/swag" const docTemplate = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "contact": {}, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/api/app/applist/list": { "get": { "description": "返回应用分类列表，每个分类下含应用信息列表；categoryId=0 返回第一个分类", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "应用列表" ], "summary": "查询应用列表", "parameters": [ { "type": "integer", "description": "当前分类ID，0表示默认第一个分类", "name": "categoryId", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.AppListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/auth/getInfo": { "get": { "description": "通过 token 获取最新用户信息，包含金币余额、VIP状态等", "produces": [ "application/json" ], "tags": [ "用户认证" ], "summary": "获取当前用户信息", "responses": { "200": { "description": "用户信息", "schema": { "$ref": "#/definitions/authser.LoginResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/auth/guest": { "post": { "description": "按设备ID创建或找回游客账号；请求头可带 Authorization 复用已有游客会话。需传 X-User-Agent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户认证" ], "summary": "游客登录", "parameters": [ { "description": "游客登录参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/authser.GuestLoginReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/authser.LoginResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/auth/login": { "post": { "description": "账号或邮箱均可作为登录凭证", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户认证" ], "summary": "登录", "parameters": [ { "description": "登录参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/authapi.loginReq" } } ], "responses": { "200": { "description": "登录成功，返回 token 及用户基本信息", "schema": { "$ref": "#/definitions/authser.LoginResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/auth/profile": { "post": { "description": "用户信息通过 token 获取，无需传账号；nickName、avatar、introduction、oldPassword+newPassword 均为可选，至少提供一项。未设置密码时传 newPassword 可设置密码，已设置密码时修改需传 oldPassword+newPassword", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户认证" ], "summary": "修改用户资料（头像 / 简介 / 密码，可任意组合）", "parameters": [ { "description": "修改资料参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/authapi.updateProfileReq" } } ], "responses": { "200": { "description": "成功", "schema": { "type": "string" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/auth/register": { "post": { "description": "传入账号、邮箱、明文密码。请求头带游客 Authorization 时升级该游客为普通用户，否则新建用户", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户认证" ], "summary": "注册", "parameters": [ { "description": "注册参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/authapi.registerReq" } } ], "responses": { "200": { "description": "注册成功，返回 token 及用户基本信息", "schema": { "$ref": "#/definitions/authser.LoginResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/auth/resetPassword": { "post": { "description": "通过账号和邮箱双重校验后重置密码，两者必须同时匹配同一用户", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户认证" ], "summary": "找回密码", "parameters": [ { "description": "找回密码参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/authapi.resetPasswordReq" } } ], "responses": { "200": { "description": "成功", "schema": { "type": "string" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/coin/buy": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据指定金币套餐发起第三方支付，返回支付链接", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "金币" ], "summary": "购买金币", "parameters": [ { "description": "购买参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/coinapi.buyCoinReq" } } ], "responses": { "200": { "description": "支付链接", "schema": { "$ref": "#/definitions/coinser.BuyCoinResp" } } } } }, "/api/app/coin/orders": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "金币" ], "summary": "查询金币购买记录", "parameters": [ { "type": "integer", "description": "页码（默认1）", "name": "page", "in": "query" }, { "type": "integer", "description": "每页数量（默认10）", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "订单列表", "schema": { "type": "object" } } } } }, "/api/app/coin/trans/export": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "导出当前登录用户的金币收入、支出流水CSV；type=0全部 1充值 2消费 3奖励", "produces": [ "text/csv" ], "tags": [ "金币" ], "summary": "导出金币余额明细 -- by 王鸣", "parameters": [ { "type": "integer", "description": "类型：0全部 1充值 2消费 3奖励", "name": "type", "in": "query" } ], "responses": { "200": { "description": "CSV文件", "schema": { "type": "file" } } } } }, "/api/app/coin/trans/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回当前登录用户的金币收入、支出流水，按交易时间倒序；type=0全部 1充值 2消费 3奖励", "produces": [ "application/json" ], "tags": [ "金币" ], "summary": "查询金币余额明细 -- by 旺鸣", "parameters": [ { "type": "integer", "description": "页码（默认1）", "name": "page", "in": "query" }, { "type": "integer", "description": "每页数量（默认10，最大100）", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "类型：0全部 1充值 2消费 3奖励", "name": "type", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/response.BasePageResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CoinTransListItemResp" } } } } ] } } } } }, "/api/app/comment/like/set": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "设置当前用户对短剧或短剧剧集评论的点赞状态", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "评论APP" ], "summary": "评论点赞/取消点赞 --by 王鸣", "parameters": [ { "description": "评论点赞设置请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.CommentLikeSetReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.CommentLikeSetResp" } }, "400": { "description": "获取失败的返回结果", "schema": { "type": "string" } } } } }, "/api/app/comment/list": { "get": { "description": "分页查询短剧或短剧剧集评论树，一级评论分页返回，二级评论挂在children中，objectType 10-短剧 11-短剧剧集", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "评论APP" ], "summary": "评论列表 --by 王鸣", "parameters": [ { "type": "integer", "description": "对象ID（短剧id 短剧剧集id）", "name": "objectId", "in": "query", "required": true }, { "type": "integer", "description": "对象类型 10-短剧 11-短剧剧集", "name": "objectType", "in": "query", "required": true }, { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "排序 1-热门，按点赞数倒序 2-最新，按创建时间倒序", "name": "sortOrder", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.GetCommentListResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommentInfo" } } } } ] } }, "400": { "description": "获取失败的返回结果", "schema": { "type": "string" } } } } }, "/api/app/comment/send": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "发布短剧或短剧剧集评论，parentsId为0发布一级评论，大于0发布二级评论，replyCommentId表示实际回复的评论，objectType 10-短剧 11-短剧剧集", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "评论APP" ], "summary": "发布评论 --by 王鸣", "parameters": [ { "description": "参数列表", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.CommentSendReq" } } ], "responses": { "200": { "description": "成功", "schema": { "type": "string" } }, "400": { "description": "获取失败的返回结果", "schema": { "type": "string" } } } } }, "/api/app/config/footer/info": { "get": { "description": "返回APP底部信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "APP配置相关接口" ], "summary": "查询APP底部信息 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.FooterInfoResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/config/info": { "get": { "description": "返回最新地址信息、完整系统配置、广告配置和全站SEO配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "APP配置相关接口" ], "summary": "查询APP公共配置 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.ConfigInfoResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/config/richtext/list": { "get": { "description": "返回启用状态的富文本内容，支持按ids或titles过滤", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "APP配置相关接口" ], "summary": "查询APP富文本内容列表 --by 王鸣", "parameters": [ { "type": "string", "description": "富文本ID，多个用英文逗号分隔", "name": "ids", "in": "query" }, { "type": "string", "description": "富文本标题，多个用英文逗号分隔", "name": "titles", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.AppRichTextListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/contactus/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "用户提交联系我们表单，问题类型：1-订单问题、2-账号问题、3-功能问题、4-体验问题、5-其他", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "联系我们相关接口" ], "summary": "提交联系我们 -- by 旺鸣", "parameters": [ { "description": "联系我们请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.ContactUsAddReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.ContactUsAddResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/feedback/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "用户提交意见反馈，问题类型，1-功能建议、2-播放问题、3-账号问题、4-其他", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "意见反馈相关接口" ], "summary": "提交意见反馈 -- by 旺鸣", "parameters": [ { "description": "意见反馈请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.FeedbackReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.FeedbackResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/navigation/header": { "get": { "description": "查询导航类型为URL模式和二级导航的头部导航配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app导航相关接口" ], "summary": "查询头部导航配置 -- by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.AppTranslationInfo" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/all/list": { "get": { "description": "分页查询已上架短剧", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端分页查询全部短剧 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "1-最新更新 2-当前热播 3-独家原创 4-随机推荐，默认1", "name": "sortType", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletAllListResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/bought/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按当前用户最近购买时间倒序分页返回已购短剧列表，并返回已购集数、消耗金币和最近观看位置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端我的已购短剧列表 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletBoughtListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/chapter/collect/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按当前用户收藏时间倒序分页返回短剧剧集收藏列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端我的短剧剧集收藏列表 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletChapterCollectListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/chapter/collect/set": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "设置当前用户短剧剧集收藏状态，收藏数只在状态真实变化时增减", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端短剧剧集收藏/取消收藏 --by 王鸣", "parameters": [ { "description": "短剧剧集收藏设置请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletChapterCollectSetReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletChapterCollectSetResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/chapter/detail": { "get": { "description": "根据短剧剧集ID查询播放页当前剧集详情；可传playletId或playletSlug校验剧集归属，slug非空时优先解析短剧ID", "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端根据ID查询短剧剧集详情 --by 王鸣", "parameters": [ { "type": "integer", "description": "短剧剧集ID", "name": "chapterId", "in": "query", "required": true }, { "type": "integer", "description": "短剧ID，传入时用于校验剧集归属", "name": "playletId", "in": "query" }, { "type": "string", "description": "短剧slug，非空时优先按slug解析短剧ID", "name": "playletSlug", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletChapterInfoResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/chapter/like/set": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "设置当前用户短剧剧集点赞状态，点赞数只在状态真实变化时增减", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端短剧剧集点赞/取消点赞 --by 王鸣", "parameters": [ { "description": "短剧剧集点赞设置请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletChapterLikeSetReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletChapterLikeSetResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/chapter/list": { "get": { "description": "根据短剧ID或slug查询右侧选集列表；slug非空时优先按slug解析短剧ID", "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端根据短剧ID查询剧集列表 --by 王鸣", "parameters": [ { "type": "integer", "description": "短剧ID", "name": "playletId", "in": "query" }, { "type": "string", "description": "短剧slug，非空时优先按slug解析短剧ID", "name": "playletSlug", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletChapterListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/chapter/unlock": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "仅金币付费剧集可调用；接口具备幂等性，已解锁剧集重复调用不会重复扣金币", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端使用金币逐集解锁短剧剧集 --by 王鸣", "parameters": [ { "description": "短剧剧集金币解锁请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletChapterUnlockReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletChapterUnlockResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/chapter/watch/report": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "上报当前用户短剧剧集播放进度，达到已看条件时用于我的收藏未看集数计算", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端短剧剧集观看上报 --by 王鸣", "parameters": [ { "description": "短剧剧集观看上报请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletChapterWatchReportReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletChapterWatchReportResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/collect/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按当前用户收藏时间倒序分页返回短剧收藏列表，并返回已看/未看集数和最近观看位置；watchStatus=0全部 1追剧中 2已看完", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端我的短剧收藏列表 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "观看状态 0-全部 1-追剧中 2-已看完", "name": "watchStatus", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletCollectListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/collect/set": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "设置当前用户短剧收藏状态，收藏数只在状态真实变化时增减", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端短剧收藏/取消收藏 --by 王鸣", "parameters": [ { "description": "短剧收藏设置请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletCollectSetReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletCollectSetResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/detail": { "get": { "description": "根据短剧ID或slug查询已上架短剧详情；slug非空时优先按slug解析短剧ID", "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端根据ID查询短剧详情 --by 王鸣", "parameters": [ { "type": "integer", "description": "短剧id", "name": "id", "in": "query" }, { "type": "string", "description": "短剧slug，非空时优先按slug解析短剧ID", "name": "slug", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletInfoResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/forward/heat": { "post": { "description": "请求一次短剧热度值增加5，仅支持已上架短剧", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端短剧转发增加热度 --by 王鸣", "parameters": [ { "description": "短剧转发加热度请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletForwardHeatReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletForwardHeatResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/guess-like/list": { "get": { "description": "根据当前短剧同题材查询猜你喜欢，排除当前短剧", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端分页查询猜你喜欢短剧 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "当前短剧ID", "name": "playletId", "in": "query", "required": true } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletGuessLikeListResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/history/clear": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "仅清空观看历史，不影响收藏列表和观看进度", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端清空我的短剧观看历史 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletHistoryClearResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/history/delete": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "删除当前用户指定短剧的观看历史，不影响观看进度、收藏和已购记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端删除单条短剧观看历史 --by 王鸣", "parameters": [ { "description": "删除单条观看历史请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletHistoryDeleteReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletHistoryDeleteResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/history/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按当前用户最近观看时间倒序分页返回短剧观看历史；pageSize默认20、最大100", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端我的短剧观看历史列表 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletHistoryListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/home": { "get": { "description": "无请求参数，返回首页banner短剧、公告和SEO信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端首页短剧接口 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.HomePlayletResponse" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/hot-like": { "get": { "description": "返回缓存的前10个热搜词，以及按收藏量最多的15部猜你喜欢短剧", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端热搜词和猜你喜欢", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletHotLikeResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/hot/list": { "get": { "description": "按热度查询已上架短剧，可排除指定短剧", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端分页查询热门短剧", "parameters": [ { "type": "integer", "description": "排除的短剧ID，默认不排除", "name": "excludePlayletId", "in": "query" }, { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletHotListResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/hot/rank/list": { "get": { "description": "分页查询已上架短剧热榜；rankType=1热播榜 2新剧榜 3追剧榜", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端分页查询热榜 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "榜单类型 1-热播榜 2-新剧榜 3-追剧榜", "name": "rankType", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletHotRankListResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/like/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按点赞时间倒序分页返回当前用户点赞且已上架的短剧", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端我的点赞短剧列表 -- by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletLikeListResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/like/set": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "设置当前用户短剧点赞状态，点赞数只在状态真实变化时增减", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端短剧点赞/取消点赞 --by 王鸣", "parameters": [ { "description": "短剧点赞设置请求", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto.PlayletLikeSetReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletLikeSetResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/search": { "get": { "description": "使用ES分页搜索已上架短剧，支持剧名、题材名、简介和标签名检索", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端ES分页搜索短剧 --by 王鸣", "parameters": [ { "type": "string", "description": "搜索关键词，支持剧名、题材名、简介和标签名", "name": "keyword", "in": "query" }, { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletSearchResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/search/suggest": { "get": { "description": "搜索框下拉联想，返回短剧列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端短剧搜索联想 --by 王鸣", "parameters": [ { "type": "string", "description": "搜索关键词", "name": "keyword", "in": "query", "required": true } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletSearchSuggestResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/tag/list": { "get": { "description": "根据标签ID或标签slug分页查询已上架短剧；slug非空时优先按slug解析标签ID；sortType=1最新 2最热 3收藏最多", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端根据标签ID分页查询短剧 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "排序 1-最新 2-最热 3-收藏最多", "name": "sortType", "in": "query" }, { "type": "integer", "description": "标签ID，tagSlug为空时必传", "name": "tagId", "in": "query" }, { "type": "string", "description": "标签slug，非空时优先按slug解析标签ID", "name": "tagSlug", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletTagVideoResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/tag/options": { "get": { "description": "无请求参数，不分页，返回已上架短剧标签列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧标签相关接口" ], "summary": "app端短剧标签列表 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletTagListResponse" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/topic/detail": { "get": { "description": "按专题ID查询专题信息和专题短剧列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端查询专题详情 --by 王鸣", "parameters": [ { "type": "integer", "description": "专题ID", "name": "id", "in": "query", "required": true }, { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletTopicDetailResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "moreTopics": { "type": "array", "items": { "$ref": "#/definitions/proto.PlayletTopicPageItem" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/playlet/topic/list": { "get": { "description": "分页查询已上架且有短剧数据的专题剧单", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧相关接口" ], "summary": "app端分页查询专题剧单 --by 王鸣", "parameters": [ { "type": "integer", "name": "pageNum", "in": "query" }, { "type": "integer", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "成功", "schema": { "allOf": [ { "$ref": "#/definitions/proto.PlayletTopicPageListResp" }, { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/proto.PlayletTopicPageItem" } } } } ] } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/recharge/package/list": { "get": { "description": "返回会员畅享和金币充值两个列表，并附带各套餐可用支付方式", "produces": [ "application/json" ], "tags": [ "金币与会员" ], "summary": "查询购买套餐列表 -- by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.RechargePackageListResp" } } } } }, "/api/app/statcenter/sync": { "post": { "description": "按 job 拉取注册/日活/充值/绑定/消费/售卡等增量数据", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "数据同步" ], "summary": "统计中心增量同步", "parameters": [ { "description": "参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/statcenter.StatcenterSyncReq" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/statcenter.StatcenterSyncResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/theme/list": { "get": { "description": "无请求参数，不分页，返回已上架题材列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app短剧题材相关接口" ], "summary": "app端短剧题材列表 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.PlayletThemeListResponse" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/translation/category/list": { "get": { "description": "无请求参数，不分页，返回启用的顶部导航分类", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "APP导航相关接口" ], "summary": "app端导航分类列表 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.AppTranslationInfo" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/upload/image": { "post": { "description": "将图片转发至存储服务 /media/web/autopublish/image", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "上传" ], "summary": "图片上传", "parameters": [ { "type": "file", "description": "图片文件", "name": "file", "in": "formData", "required": true }, { "type": "string", "description": "是否加水印：1加，其他情况不加（头像不加）", "name": "watermark", "in": "formData" } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/uploadser.ImageUploadResp" } }, "400": { "description": "参数错误", "schema": { "type": "string" } } } } }, "/api/app/user/center/data": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回当前用户观看、收藏、追剧中、已购剧集统计", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "app个人中心相关接口" ], "summary": "app个人中心数据 --by 王鸣", "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.UserCenterDataResp" } }, "400": { "description": "失败", "schema": { "type": "string" } } } } }, "/api/app/vip/orders": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "充值" ], "summary": "查询 VIP 充值记录", "parameters": [ { "type": "integer", "description": "页码（默认1）", "name": "page", "in": "query" }, { "type": "integer", "description": "每页数量（默认10）", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "订单列表", "schema": { "type": "array", "items": { "$ref": "#/definitions/vipordermod.VipOrder" } } } } } }, "/api/app/vip/pay": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "充值" ], "summary": "创建 VIP 充值订单（第三方支付）", "parameters": [ { "description": "下单参数", "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/rechargeapi.submitOrderReq" } } ], "responses": { "200": { "description": "支付链接", "schema": { "$ref": "#/definitions/rechargeser.SubmitOrderResp" } } } } }, "/richtext/:id": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "标签搜索", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "标签搜索" ], "summary": "标签搜索", "parameters": [ { "description": "参数列表", "name": "param", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "成功", "schema": { "$ref": "#/definitions/proto.HomeHtmlData" } }, "400": { "description": "获取失败的返回结果", "schema": { "type": "string" } } } } } }, "definitions": { "authapi.loginReq": { "type": "object", "required": [ "account", "password" ], "properties": { "account": { "description": "账号或邮箱", "type": "string" }, "channel": { "description": "渠道码（可选，用户无商区码时写入）", "type": "string" }, "devID": { "description": "设备唯一标示（可选）", "type": "string" }, "password": { "description": "明文密码", "type": "string" } } }, "authapi.registerReq": { "type": "object", "required": [ "accountNo", "email", "password" ], "properties": { "accountNo": { "description": "账号", "type": "string" }, "agentInviteCode": { "description": "邀请人的邀请码（可选）", "type": "string" }, "channel": { "description": "渠道码（可选，用户无商区码时写入）", "type": "string" }, "devID": { "description": "设备唯一标示（可选）", "type": "string" }, "email": { "description": "邮箱", "type": "string" }, "password": { "description": "明文密码", "type": "string" } } }, "authapi.resetPasswordReq": { "type": "object", "required": [ "accountNo", "email", "newPassword" ], "properties": { "accountNo": { "description": "账号", "type": "string" }, "email": { "description": "邮箱", "type": "string" }, "newPassword": { "description": "新密码", "type": "string" } } }, "authapi.updateProfileReq": { "type": "object", "properties": { "avatar": { "description": "新头像 URL（可选）", "type": "string" }, "introduction": { "description": "简介（可选）", "type": "string" }, "newPassword": { "description": "新密码明文（设置或修改密码时必填）", "type": "string" }, "nickName": { "description": "新昵称（可选）", "type": "string" }, "oldPassword": { "description": "旧密码明文（已设置密码时修改必填）", "type": "string" }, "privacyMode": { "description": "隐私模式：true-开启，false-关闭（可选）", "type": "boolean" } } }, "authser.GuestLoginReq": { "type": "object", "properties": { "channel": { "description": "渠道码（可选，用户无商区码时写入 DistrictCode）", "type": "string" }, "devID": { "description": "设备唯一标示（必填）", "type": "string" }, "deviceId": { "description": "备用设备ID（可选，写入 DevV2）", "type": "string" }, "mac": { "description": "设备 Mac（可选）", "type": "string" } } }, "authser.LoginResp": { "type": "object", "properties": { "accountNo": { "type": "string" }, "avatar": { "description": "头像", "type": "string" }, "currentVipExpire": { "description": "VIP 过期时间，客户端需结合 vipType 判断是否真正有效", "type": "string" }, "email": { "type": "string" }, "hasPassword": { "description": "是否已设置密码", "type": "boolean" }, "introduction": { "description": "简介", "type": "string" }, "inviteCode": { "description": "邀请码", "type": "string" }, "isNewUser": { "description": "本次是否新建游客", "type": "boolean" }, "isRegister": { "description": "是否已注册", "type": "boolean" }, "loginType": { "description": "登陆方式", "allOf": [ { "$ref": "#/definitions/pubdef.LoginType" } ] }, "nickName": { "type": "string" }, "privacyMode": { "description": "隐私模式", "type": "boolean" }, "recharge": { "description": "金币余额", "type": "integer" }, "score": { "description": "积分", "type": "integer" }, "showCardId": { "description": "最新会员卡id", "type": "integer" }, "showCardName": { "description": "最新会员卡名称", "type": "string" }, "status": { "$ref": "#/definitions/pubdef.UserStatus" }, "token": { "type": "string" }, "type": { "description": "身份类型：0游客 1普通用户", "allOf": [ { "$ref": "#/definitions/pubdef.UserType" } ] }, "userId": { "type": "integer" }, "vipType": { "$ref": "#/definitions/pubdef.VipType" } } }, "coinapi.buyCoinReq": { "type": "object", "required": [ "packageId", "payMode" ], "properties": { "packageId": { "description": "购买套餐ID（金币充值）", "type": "integer" }, "payMode": { "description": "支付方式：alipay/wechat", "type": "string" } } }, "coinser.BuyCoinResp": { "type": "object", "properties": { "isOpenNewBrowser": { "type": "boolean" }, "payUrl": { "type": "string" }, "payUrlMode": { "type": "string" }, "tradeNo": { "type": "string" } } }, "cointransmod.FlowDir": { "type": "integer", "enum": [ 1, -1 ], "x-enum-comments": { "FlowIn": "收入（充值、赠送）", "FlowOut": "支出（消费、解锁）" }, "x-enum-varnames": [ "FlowIn", "FlowOut" ] }, "cointransmod.TranType": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6 ], "x-enum-comments": { "TranTypeAdminAdjust": "管理员手动调整", "TranTypeCoinGift": "金币充值赠送", "TranTypeCoinRecharge": "金币充值（购买金币）", "TranTypeDarkAlley": "历史遗留交易类型（已下线）", "TranTypeVideoUnlock": "视频解锁", "TranTypeVipGiftCoin": "购买会员赠送金币" }, "x-enum-varnames": [ "TranTypeCoinRecharge", "TranTypeVipGiftCoin", "TranTypeDarkAlley", "TranTypeVideoUnlock", "TranTypeAdminAdjust", "TranTypeCoinGift" ] }, "proto.AdvitiseData": { "type": "object", "properties": { "AList": { "description": "固定12广告位", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "BList": { "description": "固定13广告位", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "bottomBanner": { "description": "底部banner", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "detailTopList": { "description": "详情页顶部广告", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "detailbannerList": { "description": "详情banner", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "dialogList": { "description": "弹窗广告", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "downList": { "description": "底部广告", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "floatingList": { "description": "悬浮小方块", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "friendList": { "description": "友链", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "homeList": { "description": "首页列表", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "launchScreenList": { "description": "启动页广告", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "nineGridList": { "description": "9宫格", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "pauseyList": { "description": "暂停广告", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "playList": { "description": "播放强制跳转", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "titleList": { "description": "标题广告", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } }, "videoInfoList": { "description": "视频详情", "type": "array", "items": { "$ref": "#/definitions/proxy.AdvitiseInfo" } } } }, "proto.AnnouncementItem": { "type": "object", "properties": { "content": { "description": "内容", "type": "string" }, "id": { "description": "公告ID", "type": "integer" }, "title": { "description": "标题", "type": "string" } } }, "proto.AppCategoryInfo": { "type": "object", "properties": { "appList": { "description": "应用列表", "type": "array", "items": { "$ref": "#/definitions/proto.AppInfoData" } }, "code": { "description": "分类编码（特殊值：12=广告位A 13=广告位B）", "type": "integer" }, "id": { "description": "分类ID", "type": "integer" }, "intro": { "description": "分类简介", "type": "string" }, "sort": { "description": "排序", "type": "integer" }, "title": { "description": "分类标题", "type": "string" } } }, "proto.AppInfoData": { "type": "object", "properties": { "advitiseId": { "description": "广告ID（广告条目时返回）", "type": "string" }, "categoryId": { "description": "所属分类ID", "type": "integer" }, "description": { "description": "详细描述", "type": "string" }, "id": { "description": "应用ID", "type": "integer" }, "intro": { "description": "简介", "type": "string" }, "location": { "description": "广告位置ID", "type": "integer" }, "logo": { "description": "Logo 图片地址", "type": "string" }, "name": { "description": "应用名称", "type": "string" }, "sort": { "description": "排序", "type": "integer" }, "url": { "description": "跳转链接（已含渠道码）", "type": "string" } } }, "proto.AppListResp": { "type": "object", "properties": { "advitise": { "description": "广告", "allOf": [ { "$ref": "#/definitions/proto.AdvitiseData" } ] }, "category": { "description": "当前分类（含应用列表）", "allOf": [ { "$ref": "#/definitions/proto.AppCategoryInfo" } ] }, "categoryList": { "description": "应用分类列表（含各分类下的应用列表）", "type": "array", "items": { "$ref": "#/definitions/proto.AppCategoryInfo" } }, "config": { "description": "配置信息", "allOf": [ { "$ref": "#/definitions/proto.ConfigInfo" } ] }, "path": { "description": "当前路径", "type": "string" } } }, "proto.AppRichTextItemResp": { "type": "object", "properties": { "content": { "description": "内容", "type": "string" }, "desc": { "description": "标题（app）", "type": "string" }, "id": { "description": "富文本ID", "type": "integer" }, "title": { "description": "标题", "type": "string" } } }, "proto.AppRichTextListResp": { "type": "object", "properties": { "list": { "description": "富文本内容列表", "type": "array", "items": { "$ref": "#/definitions/proto.AppRichTextItemResp" } } } }, "proto.AppTranslationInfo": { "type": "object", "properties": { "categoryList": { "type": "array", "items": { "$ref": "#/definitions/proto.TranslationCategory" } } } }, "proto.CoinTransListItemResp": { "type": "object", "properties": { "amount": { "description": "本次交易金币数，始终为正数", "type": "integer" }, "balanceAfter": { "description": "交易后余额", "type": "integer" }, "balanceBefore": { "description": "交易前余额", "type": "integer" }, "changeAmount": { "description": "带方向的金币变动数，收入为正数，支出为负数", "type": "integer" }, "createdAt": { "description": "交易时间，格式：2006-01-02 15:04:05", "type": "string" }, "flowDir": { "description": "收支方向：1-收入，-1-支出", "allOf": [ { "$ref": "#/definitions/cointransmod.FlowDir" } ] }, "flowDirName": { "description": "收支方向名称：收入/支出", "type": "string" }, "id": { "description": "流水ID", "type": "integer" }, "orderNo": { "description": "关联订单号", "type": "string" }, "relatedId": { "description": "关联内容ID", "type": "integer" }, "remark": { "description": "备注", "type": "string" }, "title": { "description": "标题，优先使用备注，备注为空时使用交易类型名称", "type": "string" }, "tranType": { "description": "交易类型 1-金币充值（购买金币）2-购买会员赠送金币 3-历史遗留 4-视频解锁 5-管理员手动调整", "allOf": [ { "$ref": "#/definitions/cointransmod.TranType" } ] }, "tranTypeName": { "description": "交易类型名称", "type": "string" } } }, "proto.CommentInfo": { "type": "object", "properties": { "children": { "description": "二级评论列表", "type": "array", "items": { "$ref": "#/definitions/proto.CommentInfo" } }, "commentCount": { "description": "二级评论数量", "type": "integer" }, "countLike": { "description": "评论点赞数", "type": "integer" }, "createdAt": { "description": "创建时间", "type": "string" }, "id": { "description": "评论ID", "type": "integer" }, "isLike": { "description": "当前用户点赞状态 1-已点赞 2-未点赞", "type": "integer" }, "level": { "description": "评论级别 1-一级评论 2-二级评论", "type": "integer" }, "objectId": { "description": "对象ID", "type": "integer" }, "objectType": { "description": "对象类型 10-短剧 11-短剧剧集", "type": "integer" }, "parentsId": { "description": "父评论ID，一级评论为0", "type": "integer" }, "replyCommentId": { "description": "被回复评论ID，一级评论为0", "type": "integer" }, "replyUserName": { "description": "被回复用户昵称", "type": "string" }, "text": { "description": "评论内容", "type": "string" }, "userAvatar": { "description": "用户头像，已拼接图片域名", "type": "string" }, "userId": { "description": "评论用户ID", "type": "integer" }, "userName": { "description": "用户名称", "type": "string" } } }, "proto.CommentLikeSetReq": { "type": "object", "required": [ "commentId", "isLike" ], "properties": { "commentId": { "description": "评论ID", "type": "integer" }, "isLike": { "description": "是否点赞，true-点赞，false-取消点赞", "type": "boolean" } } }, "proto.CommentLikeSetResp": { "type": "object", "properties": { "commentId": { "description": "评论ID", "type": "integer" }, "countLike": { "description": "评论点赞数", "type": "integer" }, "isLike": { "description": "点赞状态 1-已点赞 2-未点赞", "type": "integer" } } }, "proto.CommentSendReq": { "type": "object", "properties": { "objectId": { "description": "对象ID，短剧评论传短剧ID，剧集评论传剧集ID", "type": "integer" }, "objectType": { "description": "对象类型 10-短剧 11-短剧剧集", "type": "integer" }, "parentsId": { "description": "一级评论ID，0-发布一级评论，大于0-发布二级评论", "type": "integer" }, "replyCommentId": { "description": "被回复评论ID，0时默认回复parentsId", "type": "integer" }, "text": { "description": "评论内容", "type": "string" } } }, "proto.CommonData": { "type": "object", "properties": { "anchor": { "description": "作者/演员", "type": "string" }, "banner": { "description": "banner图，已拼接图片域名", "type": "string" }, "categoryIds": { "description": "分类ID集合", "type": "array", "items": { "type": "integer" } }, "countBrowse": { "description": "观看量", "type": "integer" }, "countCollect": { "description": "收藏数", "type": "integer" }, "countLike": { "description": "点赞数，包含真实点赞数和后台虚拟点赞数", "type": "integer" }, "cover": { "description": "竖版封面，已拼接图片域名", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "简介", "type": "string" }, "description": { "description": "SEO Description", "type": "string" }, "heatValue": { "description": "热度值", "type": "integer" }, "horizontalCover": { "description": "横版封面，已拼接图片域名", "type": "string" }, "id": { "description": "短剧id", "type": "integer" }, "isFeatured": { "description": "是否爆剧（true-是，false-否）", "type": "boolean" }, "isNew": { "description": "是否上新，本周内上架为true", "type": "boolean" }, "isRecommend": { "description": "是否推荐 true-推荐，false-不推荐", "type": "boolean" }, "mediaCreatedAt": { "description": "媒资中心创建时间", "type": "string" }, "mediaUpdatedAt": { "description": "媒资中心更新时间", "type": "string" }, "onlineAt": { "description": "上架时间", "type": "string" }, "operateType": { "description": "运营类型 1-短剧 2-漫剧", "type": "integer" }, "preview": { "description": "预告地址，详情接口返回时带播放签名", "type": "string" }, "seoInfo": { "description": "Seo相关信息", "allOf": [ { "$ref": "#/definitions/pubdef.SeoValue" } ] }, "showOnBanner": { "description": "是否显示在首页banner", "type": "boolean" }, "slug": { "description": "slug", "type": "string" }, "status": { "description": "状态: 0下架 1上架", "type": "integer" }, "tagIds": { "description": "标签ID集合", "type": "array", "items": { "type": "integer" } }, "tagNames": { "description": "标签名称集合", "type": "array", "items": { "type": "string" } }, "tagSlugs": { "description": "标签slug集合", "type": "array", "items": { "type": "string" } }, "themeIds": { "description": "题材ID集合", "type": "array", "items": { "type": "integer" } }, "themeNames": { "description": "题材名称集合", "type": "array", "items": { "type": "string" } }, "themeSlugs": { "description": "题材slug集合", "type": "array", "items": { "type": "string" } }, "title": { "description": "标题", "type": "string" }, "totalEpisode": { "description": "总集数", "type": "integer" }, "updateStatus": { "description": "更新状态 1-连载中 2-已完结", "type": "integer" }, "updatedAt": { "description": "修改时间", "type": "string" } } }, "proto.ConfigInfo": { "type": "object", "properties": { "actressBackGround": { "description": "女优通用背景图", "type": "string" }, "advitiesTopicNum": { "description": "广告间隔", "type": "integer" }, "appAddr": { "description": "APP下载地址（落地页）", "type": "string" }, "channelCode": { "description": "渠道码", "type": "string" }, "customerServiceHost": { "description": "在线客服", "type": "string" }, "dhDescription": { "description": "导航SEO描述", "type": "string" }, "dhKeyworld": { "description": "导航SEO关键字", "type": "array", "items": { "type": "string" } }, "dhNewUrlAddr1": { "description": "导航页-线路1", "type": "string" }, "dhNewUrlAddr2": { "description": "导航页-线路2", "type": "string" }, "dhNewUrlAddr3": { "description": "导航页-线路3", "type": "string" }, "dhSiteName": { "description": "导航SEO网站名称", "type": "string" }, "dhTitle": { "description": "导航SEO标题", "type": "string" }, "enableH265": { "description": "是否允许客户端使用 H265 地址播放", "type": "boolean" }, "foreverUrlAddr": { "description": "永久地址", "type": "string" }, "freeVPN": { "description": "免费vpn链接", "type": "string" }, "gitAddr": { "description": "git地址", "type": "string" }, "gmailAddr": { "description": "邮箱地址", "type": "string" }, "imgAppUsCdn": { "description": "图片CDN(海外app使用)", "type": "string" }, "imgCdn": { "description": "图片CDN", "type": "string" }, "mediaAppUsCdn": { "description": "视频CDN(海外app使用)", "type": "string" }, "newUrlAddr": { "description": "最新地址", "type": "string" }, "newUrlAddr1": { "description": "最新地址（备用地址1）", "type": "string" }, "newUrlAddr2": { "description": "最新地址（备用地址2）", "type": "string" }, "officialAppAddr": { "description": "官网app地址", "type": "string" }, "pdfAddr": { "description": "回家的路PDF", "type": "string" }, "potaoGroup": { "description": "土豆群", "type": "string" }, "qq": { "description": "qq群", "type": "string" }, "reportSdkConfig": { "description": "数据上报SDK域名配置", "type": "string" }, "telegram": { "description": "商务tg", "type": "string" }, "telegramAdd": { "description": "加入我们tg", "type": "string" }, "tgGroup": { "description": "tg群", "type": "string" }, "translationAddr": { "description": "应用导航", "type": "string" }, "tsCdn": { "description": "视频CDN", "type": "string" }, "twitterAddr": { "description": "推特地址", "type": "string" }, "useIngAddress": { "description": "所有使用中的域名", "type": "array", "items": { "type": "string" } }, "watermarkImage": { "description": "图片水印文件", "type": "string" }, "webAddr": { "description": "网站SEO网站地址", "type": "string" }, "webDescription": { "description": "网站SEO描述", "type": "string" }, "webKeyworld": { "description": "网站SEO关键字", "type": "array", "items": { "type": "string" } }, "webSiteName": { "description": "网站SEO网站名称", "type": "string" }, "webTitle": { "description": "网站SEO标题", "type": "string" }, "weiChart": { "description": "微信群", "type": "string" } } }, "proto.ConfigInfoResp": { "type": "object", "properties": { "advitise": { "description": "广告配置", "allOf": [ { "$ref": "#/definitions/proto.AdvitiseData" } ] }, "config": { "description": "完整系统配置（与首页等接口的 config 一致，含 potaoGroup 等其余字段）", "allOf": [ { "$ref": "#/definitions/proto.ConfigInfo" } ] }, "navPageList": { "description": "导航页线路集合", "type": "array", "items": { "$ref": "#/definitions/proto.NavPageItem" } }, "newAddressInfo": { "description": "最新地址信息", "allOf": [ { "$ref": "#/definitions/proto.NewAddressInfo" } ] }, "reportSdkConfig": { "description": "数据上报SDK域名配置", "type": "string" }, "seoInfo": { "description": "全站SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "seoNavInfo": { "description": "导航SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoNavInfo" } ] } } }, "proto.ContactUsAddReq": { "type": "object", "required": [ "content", "email", "title", "type" ], "properties": { "attachments": { "description": "附件地址，可存放多张图片或文件地址", "type": "array", "items": { "type": "string" } }, "content": { "description": "内容", "type": "string" }, "email": { "description": "邮箱", "type": "string" }, "title": { "description": "标题", "type": "string" }, "type": { "description": "问题类型，1-订单问题、2-账号问题、3-功能问题、4-体验问题、5-其他", "type": "integer" } } }, "proto.ContactUsAddResp": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "proto.FeedbackReq": { "type": "object", "required": [ "content", "type" ], "properties": { "contact": { "description": "联系方式，可为空", "type": "string" }, "content": { "description": "描述内容，最多500字", "type": "string" }, "screenshots": { "description": "问题截图，可存放多张图片地址", "type": "array", "items": { "type": "string" } }, "type": { "description": "问题类型，1-功能建议、2-Bug反馈、3-体验问题、4-账号问题、5-其他", "type": "integer" } } }, "proto.FeedbackResp": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "proto.FooterBrand": { "type": "object", "properties": { "content": { "description": "品牌标语", "type": "string" }, "title": { "description": "品牌标题", "type": "string" } } }, "proto.FooterContact": { "type": "object", "properties": { "name": { "description": "联系方式名称", "type": "string" }, "value": { "description": "联系方式值", "type": "string" } } }, "proto.FooterInfo": { "type": "object", "properties": { "brand": { "description": "品牌信息", "allOf": [ { "$ref": "#/definitions/proto.FooterBrand" } ] }, "contactList": { "description": "联系方式", "type": "array", "items": { "$ref": "#/definitions/proto.FooterContact" } }, "navList": { "description": "底部导航", "type": "array", "items": { "$ref": "#/definitions/proto.TranslationCategory" } } } }, "proto.FooterInfoResp": { "type": "object", "properties": { "footerInfo": { "description": "底部信息", "allOf": [ { "$ref": "#/definitions/proto.FooterInfo" } ] } } }, "proto.GetCommentListResp": { "type": "object", "properties": { "list": { "description": "数据", "type": "array", "items": { "$ref": "#/definitions/proto.CommentInfo" } }, "objectId": { "description": "对象ID", "type": "integer" }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总数量", "type": "integer" } } }, "proto.HomeConfigData": { "type": "object", "properties": { "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "描述", "type": "string" }, "id": { "description": "ID", "type": "integer" }, "list": { "description": "配置对应短剧集合，type=1时返回", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "moreCategoryId": { "description": "“更多”跳转导航分类ID", "type": "integer" }, "moreUrl": { "description": "“更多”跳转地址，空表示不展示", "type": "string" }, "name": { "description": "名称", "type": "string" }, "rank": { "description": "排序，越大越靠前", "type": "integer" }, "seoInfo": { "description": "Seo相关信息", "allOf": [ { "$ref": "#/definitions/pubdef.SeoValue" } ] }, "slug": { "description": "slug，H5 更多页优先用它", "type": "string" }, "sortType": { "description": "排序字段 1-推荐 2-热播 3-最近更新 4-新片预告 5-分类", "type": "integer" }, "status": { "description": "上下架状态 true-上架 false-下架", "type": "boolean" }, "themeList": { "description": "题材集合，type=3时返回", "type": "array", "items": { "$ref": "#/definitions/proto.HomeConfigThemeData" } }, "type": { "description": "类型 1-短剧 3-题材", "type": "integer" }, "updatedAt": { "description": "修改时间", "type": "string" } } }, "proto.HomeConfigThemeData": { "type": "object", "properties": { "icon": { "description": "题材图标，已拼接图片域名", "type": "string" }, "id": { "description": "题材ID", "type": "integer" }, "list": { "description": "题材下短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "name": { "description": "题材名称", "type": "string" }, "playletCount": { "description": "绑定短剧数量", "type": "integer" }, "rank": { "description": "排序，越大越靠前", "type": "integer" }, "seoInfo": { "description": "题材对应页面SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "slug": { "description": "题材slug", "type": "string" } } }, "proto.HomeHtmlData": { "type": "object", "properties": { "advitise": { "description": "广告", "allOf": [ { "$ref": "#/definitions/proto.AdvitiseData" } ] }, "bottonTranslations": { "description": "底部导航", "allOf": [ { "$ref": "#/definitions/proto.AppTranslationInfo" } ] }, "completePath": { "description": "请求路径", "type": "string" }, "config": { "description": "配置文件", "allOf": [ { "$ref": "#/definitions/proto.ConfigInfo" } ] }, "hotSearch": { "description": "热搜", "type": "array", "items": { "$ref": "#/definitions/proto.HotSearchItem" } }, "path": { "type": "string" }, "translations": { "description": "导航", "allOf": [ { "$ref": "#/definitions/proto.AppTranslationInfo" } ] } } }, "proto.HomePlayletResponse": { "type": "object", "properties": { "advitise": { "description": "广告", "allOf": [ { "$ref": "#/definitions/proto.AdvitiseData" } ] }, "announcements": { "description": "启用中的公告，来自独立缓存", "type": "array", "items": { "$ref": "#/definitions/proto.AnnouncementItem" } }, "homeBannerData": { "description": "首页banner短剧信息列表", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "homeConfigData": { "description": "首页配置集合", "type": "array", "items": { "$ref": "#/definitions/proto.HomeConfigData" } }, "hotSearch": { "description": "大家都在搜，按搜索次数排序，最多15个", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletHotSearchItem" } }, "seoInfo": { "description": "页面SEO信息（短剧列表页SEO）", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] } } }, "proto.HotSearchItem": { "type": "object", "properties": { "addedTime": { "description": "上架shi时间", "type": "string" }, "desc": { "description": "描述", "type": "string" }, "hotValue": { "description": "热度值", "type": "integer" }, "id": { "description": "ID", "type": "integer" }, "images": { "description": "封面", "type": "string" }, "title": { "description": "标题", "type": "string" }, "works": { "description": "作品数量", "type": "integer" } } }, "proto.NavPageItem": { "type": "object", "properties": { "line": { "description": "线路序号", "type": "integer" }, "url": { "description": "线路地址", "type": "string" } } }, "proto.NewAddressInfo": { "type": "object", "properties": { "appAddr": { "description": "APP下载地址（落地页）", "type": "string" }, "customerServiceHost": { "description": "在线客服", "type": "string" }, "foreverUrlAddr": { "description": "永久海外地址(翻墙访问 永不迷路)", "type": "string" }, "gmailAddr": { "description": "邮箱地址", "type": "string" }, "newUrlAddr": { "description": "新国内地址", "type": "string" }, "newUrlAddr1": { "description": "备用地址1", "type": "string" }, "newUrlAddr2": { "description": "备用地址1", "type": "string" }, "officialAppAddr": { "description": "官网app地址", "type": "string" }, "pdfAddr": { "description": "回家的路PDF", "type": "string" }, "telegram": { "description": "商务tg", "type": "string" }, "tgGroup": { "description": "tg群", "type": "string" }, "twitterAddr": { "description": "推特地址", "type": "string" } } }, "proto.PayMethodInfo": { "type": "object", "properties": { "type": { "description": "alipay / wechat / union", "type": "string" }, "typeName": { "description": "支付宝 / 微信 / 银联", "type": "string" } } }, "proto.PlayletAllListResp": { "type": "object", "properties": { "list": { "description": "短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "seoInfo": { "description": "页面SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.PlayletBoughtData": { "type": "object", "properties": { "anchor": { "description": "作者/演员", "type": "string" }, "banner": { "description": "banner图，已拼接图片域名", "type": "string" }, "boughtAt": { "description": "最近购买时间", "type": "string" }, "boughtChapterCount": { "description": "已购剧集数量", "type": "integer" }, "categoryIds": { "description": "分类ID集合", "type": "array", "items": { "type": "integer" } }, "costCoins": { "description": "已消耗金币", "type": "integer" }, "countBrowse": { "description": "观看量", "type": "integer" }, "countCollect": { "description": "收藏数", "type": "integer" }, "countLike": { "description": "点赞数，包含真实点赞数和后台虚拟点赞数", "type": "integer" }, "cover": { "description": "竖版封面，已拼接图片域名", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "简介", "type": "string" }, "description": { "description": "SEO Description", "type": "string" }, "heatValue": { "description": "热度值", "type": "integer" }, "horizontalCover": { "description": "横版封面，已拼接图片域名", "type": "string" }, "id": { "description": "短剧id", "type": "integer" }, "isFeatured": { "description": "是否爆剧（true-是，false-否）", "type": "boolean" }, "isFinished": { "description": "当前用户是否已看完", "type": "boolean" }, "isNew": { "description": "是否上新，本周内上架为true", "type": "boolean" }, "isRecommend": { "description": "是否推荐 true-推荐，false-不推荐", "type": "boolean" }, "lastChapterId": { "description": "最近观看剧集ID，无观看进度时为0", "type": "integer" }, "lastEpisode": { "description": "最近观看集数，无观看进度时为0", "type": "integer" }, "mediaCreatedAt": { "description": "媒资中心创建时间", "type": "string" }, "mediaUpdatedAt": { "description": "媒资中心更新时间", "type": "string" }, "onlineAt": { "description": "上架时间", "type": "string" }, "operateType": { "description": "运营类型 1-短剧 2-漫剧", "type": "integer" }, "preview": { "description": "预告地址，详情接口返回时带播放签名", "type": "string" }, "seoInfo": { "description": "Seo相关信息", "allOf": [ { "$ref": "#/definitions/pubdef.SeoValue" } ] }, "showOnBanner": { "description": "是否显示在首页banner", "type": "boolean" }, "slug": { "description": "slug", "type": "string" }, "status": { "description": "状态: 0下架 1上架", "type": "integer" }, "tagIds": { "description": "标签ID集合", "type": "array", "items": { "type": "integer" } }, "tagNames": { "description": "标签名称集合", "type": "array", "items": { "type": "string" } }, "tagSlugs": { "description": "标签slug集合", "type": "array", "items": { "type": "string" } }, "themeIds": { "description": "题材ID集合", "type": "array", "items": { "type": "integer" } }, "themeNames": { "description": "题材名称集合", "type": "array", "items": { "type": "string" } }, "themeSlugs": { "description": "题材slug集合", "type": "array", "items": { "type": "string" } }, "title": { "description": "标题", "type": "string" }, "totalEpisode": { "description": "总集数", "type": "integer" }, "unwatchedCount": { "description": "当前用户未看集数，按totalEpisode-watchedCount计算", "type": "integer" }, "updateStatus": { "description": "更新状态 1-连载中 2-已完结", "type": "integer" }, "updatedAt": { "description": "修改时间", "type": "string" }, "watchedCount": { "description": "当前用户已看集数", "type": "integer" } } }, "proto.PlayletBoughtListResp": { "type": "object", "properties": { "list": { "description": "已购短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletBoughtData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总已购短剧数量", "type": "integer" } } }, "proto.PlayletChapterCollectData": { "type": "object", "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "chapterTitle": { "description": "剧集标题", "type": "string" }, "collectedAt": { "description": "收藏时间", "type": "string" }, "countBrowse": { "description": "剧集观看数", "type": "integer" }, "countCollect": { "description": "剧集收藏数", "type": "integer" }, "currentEpisode": { "description": "第几集", "type": "integer" }, "isCollect": { "description": "收藏状态，收藏列表固定返回1-已收藏", "type": "integer" }, "mediaTime": { "description": "影片长度(秒)", "type": "integer" }, "payType": { "description": "支付方式 0-免费 1-金币 2-VIP", "type": "integer" }, "playletCover": { "description": "短剧封面，已拼接图片域名", "type": "string" }, "playletId": { "description": "短剧ID", "type": "integer" }, "playletTitle": { "description": "短剧标题", "type": "string" }, "singleCoins": { "description": "单集金币", "type": "integer" }, "totalEpisode": { "description": "短剧总集数", "type": "integer" }, "updateStatus": { "description": "更新状态 1-连载中 2-已完结", "type": "integer" }, "videoUrl": { "description": "播放地址", "type": "string" } } }, "proto.PlayletChapterCollectListResp": { "type": "object", "properties": { "list": { "description": "收藏剧集集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletChapterCollectData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总收藏数量", "type": "integer" } } }, "proto.PlayletChapterCollectSetReq": { "type": "object", "required": [ "chapterId", "isCollect" ], "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "isCollect": { "description": "是否收藏，true-收藏，false-取消收藏", "type": "boolean" } } }, "proto.PlayletChapterCollectSetResp": { "type": "object", "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "countCollect": { "description": "短剧剧集收藏数", "type": "integer" }, "isCollect": { "description": "收藏状态 1-已收藏 2-未收藏", "type": "integer" } } }, "proto.PlayletChapterData": { "type": "object", "properties": { "balance": { "description": "当前金币余额", "type": "integer" }, "canWatch": { "description": "是否可观看", "type": "boolean" }, "costCoins": { "description": "本次解锁消耗金币", "type": "integer" }, "currentEpisode": { "description": "第几集", "type": "integer" }, "hash": { "description": "媒体hash", "type": "string" }, "height": { "description": "高", "type": "integer" }, "id": { "description": "短剧剧集ID", "type": "integer" }, "isUnlocked": { "description": "当前用户是否已解锁本集", "type": "boolean" }, "md5": { "description": "媒体md5", "type": "string" }, "mediaSize": { "description": "资源大小", "type": "integer" }, "mediaTime": { "description": "影片长度(秒)", "type": "integer" }, "needUnlock": { "description": "是否需要金币解锁", "type": "boolean" }, "needVip": { "description": "是否需要开通VIP", "type": "boolean" }, "payType": { "description": "支付方式 0-免费 1-金币 2-VIP", "type": "integer" }, "playletId": { "description": "短剧ID", "type": "integer" }, "ratio": { "description": "宽高比", "type": "number" }, "singleCoins": { "description": "单集金币（支付方式为1-金币时候生效）", "type": "integer" }, "title": { "description": "章节名", "type": "string" }, "videoUrl": { "description": "视频地址", "type": "string" }, "vipValid": { "description": "当前用户VIP是否有效", "type": "boolean" }, "width": { "description": "宽", "type": "integer" } } }, "proto.PlayletChapterInfoResp": { "type": "object", "properties": { "balance": { "description": "当前金币余额", "type": "integer" }, "canWatch": { "description": "是否可观看", "type": "boolean" }, "costCoins": { "description": "本次解锁消耗金币", "type": "integer" }, "countBrowse": { "description": "短剧剧集观看数", "type": "integer" }, "countCollect": { "description": "短剧剧集收藏数", "type": "integer" }, "countComment": { "description": "短剧剧集评论数", "type": "integer" }, "countLike": { "description": "短剧剧集点赞数", "type": "integer" }, "currentEpisode": { "description": "第几集", "type": "integer" }, "hash": { "description": "媒体hash", "type": "string" }, "height": { "description": "高", "type": "integer" }, "id": { "description": "短剧剧集ID", "type": "integer" }, "isCollect": { "description": "收藏状态 1-已收藏 2-未收藏", "type": "integer" }, "isLike": { "description": "点赞状态 1-已点赞 2-未点赞", "type": "integer" }, "isUnlocked": { "description": "当前用户是否已解锁本集", "type": "boolean" }, "md5": { "description": "媒体md5", "type": "string" }, "mediaSize": { "description": "资源大小", "type": "integer" }, "mediaTime": { "description": "影片长度(秒)", "type": "integer" }, "needUnlock": { "description": "是否需要金币解锁", "type": "boolean" }, "needVip": { "description": "是否需要开通VIP", "type": "boolean" }, "payType": { "description": "支付方式 0-免费 1-金币 2-VIP", "type": "integer" }, "playletId": { "description": "短剧ID", "type": "integer" }, "ratio": { "description": "宽高比", "type": "number" }, "seoInfo": { "description": "页面SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "singleCoins": { "description": "单集金币（支付方式为1-金币时候生效）", "type": "integer" }, "title": { "description": "章节名", "type": "string" }, "videoUrl": { "description": "视频地址", "type": "string" }, "vipValid": { "description": "当前用户VIP是否有效", "type": "boolean" }, "width": { "description": "宽", "type": "integer" } } }, "proto.PlayletChapterLikeSetReq": { "type": "object", "required": [ "chapterId", "isLike" ], "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "isLike": { "description": "是否点赞，true-点赞，false-取消点赞", "type": "boolean" } } }, "proto.PlayletChapterLikeSetResp": { "type": "object", "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "countLike": { "description": "短剧剧集点赞数", "type": "integer" }, "isLike": { "description": "点赞状态 1-已点赞 2-未点赞", "type": "integer" } } }, "proto.PlayletChapterListResp": { "type": "object", "properties": { "list": { "description": "短剧剧集集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletChapterData" } }, "playletId": { "description": "短剧ID", "type": "integer" } } }, "proto.PlayletChapterUnlockReq": { "type": "object", "required": [ "chapterId", "playletId" ], "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "playletId": { "description": "短剧ID", "type": "integer" } } }, "proto.PlayletChapterUnlockResp": { "type": "object", "properties": { "balance": { "description": "当前金币余额", "type": "integer" }, "canWatch": { "description": "是否可观看", "type": "boolean" }, "changeCoin": { "description": "本次实际扣减金币，幂等命中时为0", "type": "integer" }, "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "costCoins": { "description": "本次解锁消耗金币", "type": "integer" }, "playletId": { "description": "短剧ID", "type": "integer" }, "unlocked": { "description": "是否已解锁", "type": "boolean" } } }, "proto.PlayletChapterWatchReportReq": { "type": "object", "required": [ "chapterId" ], "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "playletId": { "description": "短剧ID，传入时用于校验剧集归属", "type": "integer" } } }, "proto.PlayletChapterWatchReportResp": { "type": "object", "properties": { "chapterId": { "description": "短剧剧集ID", "type": "integer" }, "currentEpisode": { "description": "当前集数", "type": "integer" }, "lastChapterId": { "description": "最近观看剧集ID", "type": "integer" }, "lastEpisode": { "description": "最近观看集数", "type": "integer" }, "playletId": { "description": "短剧ID", "type": "integer" }, "unwatchedCount": { "description": "当前用户未看集数", "type": "integer" }, "watchedCount": { "description": "当前用户已看集数", "type": "integer" } } }, "proto.PlayletCollectData": { "type": "object", "properties": { "collectedAt": { "description": "收藏时间", "type": "string" }, "countBrowse": { "description": "观看量", "type": "integer" }, "countCollect": { "description": "收藏数", "type": "integer" }, "cover": { "description": "封面，已拼接图片域名", "type": "string" }, "heatValue": { "description": "热度值", "type": "integer" }, "id": { "description": "短剧ID", "type": "integer" }, "isCollect": { "description": "收藏状态，收藏列表固定返回1-已收藏", "type": "integer" }, "lastChapterId": { "description": "最近观看剧集ID，无观看进度时为0", "type": "integer" }, "lastEpisode": { "description": "最近观看集数，无观看进度时为0", "type": "integer" }, "seoInfo": { "description": "Seo相关信息", "allOf": [ { "$ref": "#/definitions/pubdef.SeoValue" } ] }, "slug": { "description": "slug", "type": "string" }, "tagIds": { "description": "标签ID集合", "type": "array", "items": { "type": "integer" } }, "tagNames": { "description": "标签名称集合", "type": "array", "items": { "type": "string" } }, "tagSlugs": { "description": "标签slug集合", "type": "array", "items": { "type": "string" } }, "themeIds": { "description": "题材ID集合", "type": "array", "items": { "type": "integer" } }, "themeNames": { "description": "题材名称集合", "type": "array", "items": { "type": "string" } }, "themeSlugs": { "description": "题材slug集合", "type": "array", "items": { "type": "string" } }, "title": { "description": "标题", "type": "string" }, "totalEpisode": { "description": "总集数", "type": "integer" }, "unwatchedCount": { "description": "当前用户未看集数，按totalEpisode-watchedCount计算", "type": "integer" }, "updateStatus": { "description": "更新状态 1-连载中 2-已完结", "type": "integer" }, "watchedCount": { "description": "当前用户已看集数", "type": "integer" } } }, "proto.PlayletCollectListResp": { "type": "object", "properties": { "list": { "description": "收藏短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletCollectData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总收藏数量", "type": "integer" } } }, "proto.PlayletCollectSetReq": { "type": "object", "required": [ "id", "isCollect" ], "properties": { "id": { "description": "短剧ID", "type": "integer" }, "isCollect": { "description": "是否收藏，true-收藏，false-取消收藏", "type": "boolean" } } }, "proto.PlayletCollectSetResp": { "type": "object", "properties": { "countCollect": { "description": "短剧收藏数", "type": "integer" }, "id": { "description": "短剧ID", "type": "integer" }, "isCollect": { "description": "收藏状态 1-已收藏 2-未收藏", "type": "integer" } } }, "proto.PlayletForwardHeatReq": { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "短剧ID", "type": "integer" } } }, "proto.PlayletForwardHeatResp": { "type": "object", "properties": { "heatValue": { "description": "加热后的热度值", "type": "integer" }, "id": { "description": "短剧ID", "type": "integer" } } }, "proto.PlayletGuessLikeListResp": { "type": "object", "properties": { "list": { "description": "猜你喜欢短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.PlayletHistoryClearResp": { "type": "object", "properties": { "deletedCount": { "description": "删除记录数量", "type": "integer" } } }, "proto.PlayletHistoryData": { "type": "object", "properties": { "anchor": { "description": "作者/演员", "type": "string" }, "banner": { "description": "banner图，已拼接图片域名", "type": "string" }, "categoryIds": { "description": "分类ID集合", "type": "array", "items": { "type": "integer" } }, "countBrowse": { "description": "观看量", "type": "integer" }, "countCollect": { "description": "收藏数", "type": "integer" }, "countLike": { "description": "点赞数，包含真实点赞数和后台虚拟点赞数", "type": "integer" }, "cover": { "description": "竖版封面，已拼接图片域名", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "简介", "type": "string" }, "description": { "description": "SEO Description", "type": "string" }, "heatValue": { "description": "热度值", "type": "integer" }, "historyAt": { "description": "最近观看时间", "type": "string" }, "horizontalCover": { "description": "横版封面，已拼接图片域名", "type": "string" }, "id": { "description": "短剧id", "type": "integer" }, "isFeatured": { "description": "是否爆剧（true-是，false-否）", "type": "boolean" }, "isFinished": { "description": "是否已看完", "type": "boolean" }, "isNew": { "description": "是否上新，本周内上架为true", "type": "boolean" }, "isRecommend": { "description": "是否推荐 true-推荐，false-不推荐", "type": "boolean" }, "lastChapterId": { "description": "最近观看剧集ID", "type": "integer" }, "lastEpisode": { "description": "最近观看集数", "type": "integer" }, "mediaCreatedAt": { "description": "媒资中心创建时间", "type": "string" }, "mediaUpdatedAt": { "description": "媒资中心更新时间", "type": "string" }, "onlineAt": { "description": "上架时间", "type": "string" }, "operateType": { "description": "运营类型 1-短剧 2-漫剧", "type": "integer" }, "preview": { "description": "预告地址，详情接口返回时带播放签名", "type": "string" }, "seoInfo": { "description": "Seo相关信息", "allOf": [ { "$ref": "#/definitions/pubdef.SeoValue" } ] }, "showOnBanner": { "description": "是否显示在首页banner", "type": "boolean" }, "slug": { "description": "slug", "type": "string" }, "status": { "description": "状态: 0下架 1上架", "type": "integer" }, "tagIds": { "description": "标签ID集合", "type": "array", "items": { "type": "integer" } }, "tagNames": { "description": "标签名称集合", "type": "array", "items": { "type": "string" } }, "tagSlugs": { "description": "标签slug集合", "type": "array", "items": { "type": "string" } }, "themeIds": { "description": "题材ID集合", "type": "array", "items": { "type": "integer" } }, "themeNames": { "description": "题材名称集合", "type": "array", "items": { "type": "string" } }, "themeSlugs": { "description": "题材slug集合", "type": "array", "items": { "type": "string" } }, "title": { "description": "标题", "type": "string" }, "totalEpisode": { "description": "总集数", "type": "integer" }, "unwatchedCount": { "description": "当前用户未看集数", "type": "integer" }, "updateStatus": { "description": "更新状态 1-连载中 2-已完结", "type": "integer" }, "updatedAt": { "description": "修改时间", "type": "string" }, "watchedCount": { "description": "当前用户已看集数", "type": "integer" } } }, "proto.PlayletHistoryDeleteReq": { "type": "object", "required": [ "playletId" ], "properties": { "playletId": { "description": "短剧ID", "type": "integer" } } }, "proto.PlayletHistoryDeleteResp": { "type": "object", "properties": { "deletedCount": { "description": "删除记录数量", "type": "integer" } } }, "proto.PlayletHistoryListResp": { "type": "object", "properties": { "list": { "description": "观看历史集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletHistoryData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总历史数量", "type": "integer" } } }, "proto.PlayletHotLikeResp": { "type": "object", "properties": { "guessLike": { "description": "按收藏量最多的15部上架短剧", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "hotSearch": { "description": "前10个热搜词", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletHotSearchItem" } } } }, "proto.PlayletHotListResp": { "type": "object", "properties": { "list": { "description": "短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.PlayletHotRankListResp": { "type": "object", "properties": { "list": { "description": "短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "rankType": { "description": "榜单类型 1-热播榜 2-新剧榜 3-追剧榜", "type": "integer" }, "seoInfo": { "description": "页面SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.PlayletHotSearchItem": { "type": "object", "properties": { "count": { "description": "搜索次数", "type": "integer" }, "keyword": { "description": "搜索词", "type": "string" } } }, "proto.PlayletInfoResp": { "type": "object", "properties": { "advitise": { "description": "广告", "allOf": [ { "$ref": "#/definitions/proto.AdvitiseData" } ] }, "anchor": { "description": "作者/演员", "type": "string" }, "banner": { "description": "banner图，已拼接图片域名", "type": "string" }, "categoryIds": { "description": "分类ID集合", "type": "array", "items": { "type": "integer" } }, "countBrowse": { "description": "观看量", "type": "integer" }, "countCollect": { "description": "收藏数", "type": "integer" }, "countLike": { "description": "点赞数，包含真实点赞数和后台虚拟点赞数", "type": "integer" }, "cover": { "description": "竖版封面，已拼接图片域名", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "简介", "type": "string" }, "description": { "description": "SEO Description", "type": "string" }, "heatValue": { "description": "热度值", "type": "integer" }, "horizontalCover": { "description": "横版封面，已拼接图片域名", "type": "string" }, "id": { "description": "短剧id", "type": "integer" }, "isCollect": { "description": "是否收藏（1-已收藏，2-未收藏）", "type": "integer" }, "isFeatured": { "description": "是否爆剧（true-是，false-否）", "type": "boolean" }, "isLike": { "description": "是否点赞（1-已点赞，2-未点赞）", "type": "integer" }, "isNew": { "description": "是否上新，本周内上架为true", "type": "boolean" }, "isRecommend": { "description": "是否推荐 true-推荐，false-不推荐", "type": "boolean" }, "mediaCreatedAt": { "description": "媒资中心创建时间", "type": "string" }, "mediaUpdatedAt": { "description": "媒资中心更新时间", "type": "string" }, "onlineAt": { "description": "上架时间", "type": "string" }, "operateType": { "description": "运营类型 1-短剧 2-漫剧", "type": "integer" }, "playletChapterInfo": { "description": "短剧章节集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletChapterData" } }, "preview": { "description": "预告地址，详情接口返回时带播放签名", "type": "string" }, "seoInfo": { "description": "页面SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "showOnBanner": { "description": "是否显示在首页banner", "type": "boolean" }, "slug": { "description": "slug", "type": "string" }, "status": { "description": "状态: 0下架 1上架", "type": "integer" }, "tagIds": { "description": "标签ID集合", "type": "array", "items": { "type": "integer" } }, "tagNames": { "description": "标签名称集合", "type": "array", "items": { "type": "string" } }, "tagSlugs": { "description": "标签slug集合", "type": "array", "items": { "type": "string" } }, "themeIds": { "description": "题材ID集合", "type": "array", "items": { "type": "integer" } }, "themeNames": { "description": "题材名称集合", "type": "array", "items": { "type": "string" } }, "themeSlugs": { "description": "题材slug集合", "type": "array", "items": { "type": "string" } }, "title": { "description": "标题", "type": "string" }, "totalEpisode": { "description": "总集数", "type": "integer" }, "updateStatus": { "description": "更新状态 1-连载中 2-已完结", "type": "integer" }, "updatedAt": { "description": "修改时间", "type": "string" } } }, "proto.PlayletLikeData": { "type": "object", "properties": { "anchor": { "description": "作者/演员", "type": "string" }, "banner": { "description": "banner图，已拼接图片域名", "type": "string" }, "categoryIds": { "description": "分类ID集合", "type": "array", "items": { "type": "integer" } }, "countBrowse": { "description": "观看量", "type": "integer" }, "countCollect": { "description": "收藏数", "type": "integer" }, "countLike": { "description": "点赞数，包含真实点赞数和后台虚拟点赞数", "type": "integer" }, "cover": { "description": "竖版封面，已拼接图片域名", "type": "string" }, "createdAt": { "description": "创建时间", "type": "string" }, "desc": { "description": "简介", "type": "string" }, "description": { "description": "SEO Description", "type": "string" }, "heatValue": { "description": "热度值", "type": "integer" }, "horizontalCover": { "description": "横版封面，已拼接图片域名", "type": "string" }, "id": { "description": "短剧id", "type": "integer" }, "isFeatured": { "description": "是否爆剧（true-是，false-否）", "type": "boolean" }, "isLike": { "description": "点赞状态，固定为1", "type": "integer" }, "isNew": { "description": "是否上新，本周内上架为true", "type": "boolean" }, "isRecommend": { "description": "是否推荐 true-推荐，false-不推荐", "type": "boolean" }, "likedAt": { "description": "点赞时间", "type": "string" }, "mediaCreatedAt": { "description": "媒资中心创建时间", "type": "string" }, "mediaUpdatedAt": { "description": "媒资中心更新时间", "type": "string" }, "onlineAt": { "description": "上架时间", "type": "string" }, "operateType": { "description": "运营类型 1-短剧 2-漫剧", "type": "integer" }, "preview": { "description": "预告地址，详情接口返回时带播放签名", "type": "string" }, "seoInfo": { "description": "Seo相关信息", "allOf": [ { "$ref": "#/definitions/pubdef.SeoValue" } ] }, "showOnBanner": { "description": "是否显示在首页banner", "type": "boolean" }, "slug": { "description": "slug", "type": "string" }, "status": { "description": "状态: 0下架 1上架", "type": "integer" }, "tagIds": { "description": "标签ID集合", "type": "array", "items": { "type": "integer" } }, "tagNames": { "description": "标签名称集合", "type": "array", "items": { "type": "string" } }, "tagSlugs": { "description": "标签slug集合", "type": "array", "items": { "type": "string" } }, "themeIds": { "description": "题材ID集合", "type": "array", "items": { "type": "integer" } }, "themeNames": { "description": "题材名称集合", "type": "array", "items": { "type": "string" } }, "themeSlugs": { "description": "题材slug集合", "type": "array", "items": { "type": "string" } }, "title": { "description": "标题", "type": "string" }, "totalEpisode": { "description": "总集数", "type": "integer" }, "updateStatus": { "description": "更新状态 1-连载中 2-已完结", "type": "integer" }, "updatedAt": { "description": "修改时间", "type": "string" } } }, "proto.PlayletLikeListResp": { "type": "object", "properties": { "list": { "description": "点赞短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletLikeData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.PlayletLikeSetReq": { "type": "object", "required": [ "id", "isLike" ], "properties": { "id": { "description": "短剧ID", "type": "integer" }, "isLike": { "description": "是否点赞，true-点赞，false-取消点赞", "type": "boolean" } } }, "proto.PlayletLikeSetResp": { "type": "object", "properties": { "countLike": { "description": "短剧点赞数", "type": "integer" }, "id": { "description": "短剧ID", "type": "integer" }, "isLike": { "description": "点赞状态 1-已点赞 2-未点赞", "type": "integer" } } }, "proto.PlayletSearchResp": { "type": "object", "properties": { "everyoneWatching": { "description": "大家都在看，搜索无结果时返回", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "keyword": { "description": "搜索词", "type": "string" }, "list": { "description": "搜索结果", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.PlayletSearchSuggestResp": { "type": "object", "properties": { "keyword": { "description": "搜索关键词", "type": "string" }, "list": { "description": "短剧列表", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } } } }, "proto.PlayletTagItem": { "type": "object", "properties": { "id": { "description": "标签ID", "type": "integer" }, "name": { "description": "标签名称", "type": "string" }, "rank": { "description": "排序，越大越靠前", "type": "integer" }, "seoInfo": { "description": "标签对应页面 SEO 信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "slug": { "description": "slug", "type": "string" }, "status": { "description": "上架状态", "type": "boolean" } } }, "proto.PlayletTagListResponse": { "type": "object", "properties": { "list": { "description": "标签列表", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletTagItem" } } } }, "proto.PlayletTagVideoResp": { "type": "object", "properties": { "list": { "description": "短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "seoInfo": { "description": "页面SEO信息（标签SEO）", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.PlayletThemeItem": { "type": "object", "properties": { "icon": { "description": "题材图标，已拼接图片域名", "type": "string" }, "id": { "description": "题材ID", "type": "integer" }, "isRecommend": { "description": "是否推荐", "type": "boolean" }, "name": { "description": "题材名称", "type": "string" }, "playletCount": { "description": "该题材绑定的上架短剧数量", "type": "integer" }, "rank": { "description": "排序，越大越靠前", "type": "integer" }, "seoInfo": { "description": "题材对应页面 SEO 信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "slug": { "description": "slug", "type": "string" }, "status": { "description": "上架状态", "type": "boolean" } } }, "proto.PlayletThemeListResponse": { "type": "object", "properties": { "list": { "description": "题材列表", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletThemeItem" } } } }, "proto.PlayletTopicDetailResp": { "type": "object", "properties": { "covers": { "description": "顶部封面集合", "type": "array", "items": { "type": "string" } }, "desc": { "description": "描述", "type": "string" }, "icon": { "description": "图标", "type": "string" }, "id": { "description": "专题ID", "type": "integer" }, "list": { "description": "专题短剧列表", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "moreTopics": { "description": "更多专题", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletTopicPageItem" } }, "name": { "description": "专题名称", "type": "string" }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "playletCount": { "description": "上架短剧数量", "type": "integer" }, "rank": { "description": "排序，越大越靠前", "type": "integer" }, "seoInfo": { "description": "专题SEO", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "slug": { "description": "slug", "type": "string" }, "totalCount": { "description": "短剧总数", "type": "integer" } } }, "proto.PlayletTopicPageItem": { "type": "object", "properties": { "covers": { "description": "展示封面集合", "type": "array", "items": { "type": "string" } }, "desc": { "description": "描述", "type": "string" }, "icon": { "description": "图标", "type": "string" }, "id": { "description": "专题ID", "type": "integer" }, "list": { "description": "专题下短剧集合", "type": "array", "items": { "$ref": "#/definitions/proto.CommonData" } }, "name": { "description": "专题名称", "type": "string" }, "playletCount": { "description": "上架短剧数量", "type": "integer" }, "rank": { "description": "排序，越大越靠前", "type": "integer" }, "seoInfo": { "description": "专题SEO", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "slug": { "description": "slug", "type": "string" } } }, "proto.PlayletTopicPageListResp": { "type": "object", "properties": { "list": { "description": "专题集合", "type": "array", "items": { "$ref": "#/definitions/proto.PlayletTopicPageItem" } }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "seoInfo": { "description": "页面SEO信息", "allOf": [ { "$ref": "#/definitions/proto.SeoInfo" } ] }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "proto.RechargePackageItem": { "type": "object", "properties": { "baseCoin": { "description": "基础金币数", "type": "integer" }, "durationDays": { "description": "会员有效天数", "type": "integer" }, "durationHours": { "description": "会员有效小时数，由durationDays计算", "type": "integer" }, "giftCoin": { "description": "赠送金币数", "type": "integer" }, "id": { "description": "套餐ID", "type": "integer" }, "name": { "description": "展示标题", "type": "string" }, "originalPrice": { "description": "原价，单位分", "type": "integer" }, "packageType": { "description": "套餐类型：1-会员畅享 2-金币充值", "allOf": [ { "$ref": "#/definitions/rechargepackagemod.PackageType" } ] }, "payMethods": { "description": "该套餐支持的支付方式", "type": "array", "items": { "$ref": "#/definitions/proto.PayMethodInfo" } }, "price": { "description": "售价，单位分", "type": "integer" }, "sort": { "description": "排序，越小越靠前", "type": "integer" }, "subTitle": { "description": "展示副标题", "type": "string" }, "totalCoin": { "description": "到账总金币数，由baseCoin+giftCoin计算", "type": "integer" } } }, "proto.RechargePackageListResp": { "type": "object", "properties": { "coinList": { "description": "金币充值列表", "type": "array", "items": { "$ref": "#/definitions/proto.RechargePackageItem" } }, "vipList": { "description": "会员畅享列表", "type": "array", "items": { "$ref": "#/definitions/proto.RechargePackageItem" } } } }, "proto.SeoInfo": { "type": "object", "properties": { "canonicalUrl": { "description": "当前内容的标准URL", "type": "string" }, "description": { "description": "页面描述", "type": "string" }, "keywords": { "description": "页面关键词", "type": "array", "items": { "type": "string" } }, "title": { "description": "页面标题", "type": "string" }, "webSiteName": { "description": "网站名称", "type": "string" } } }, "proto.SeoNavInfo": { "type": "object", "properties": { "dhDescription": { "description": "导航描述", "type": "string" }, "dhKeyworld": { "description": "关键词", "type": "array", "items": { "type": "string" } }, "dhSiteName": { "description": "导航名称", "type": "string" }, "dhTitle": { "description": "导航标题", "type": "string" } } }, "proto.TranslationCategory": { "type": "object", "properties": { "categoryType": { "description": "导航类型", "allOf": [ { "$ref": "#/definitions/pubdef.TranslationType" } ] }, "icon": { "description": "Icon", "type": "string" }, "id": { "type": "integer" }, "name": { "description": "名称", "type": "string" }, "seoInfo": { "description": "Seo相关信息", "allOf": [ { "$ref": "#/definitions/pubdef.SeoValue" } ] }, "translationList": { "type": "array", "items": { "$ref": "#/definitions/proto.TranslationInfo" } }, "urlValue": { "description": "URl路径", "type": "string" } } }, "proto.TranslationInfo": { "type": "object", "properties": { "id": { "description": "ID", "type": "integer" }, "isFriendAds": { "description": "是否是友链广告位", "type": "boolean" }, "name": { "description": "名称", "type": "string" }, "urlValue": { "description": "URl路径", "type": "string" } } }, "proto.UserCenterDataResp": { "type": "object", "properties": { "boughtChapterCount": { "description": "已购剧集数量", "type": "integer" }, "chasingCount": { "description": "追剧中数量", "type": "integer" }, "collectCount": { "description": "收藏数量", "type": "integer" }, "watchCount": { "description": "观看数量", "type": "integer" } } }, "proxy.AdvitiseInfo": { "type": "object", "properties": { "id": { "description": "广告id", "type": "string" }, "images": { "description": "视频banner", "type": "string" }, "link": { "description": "链接", "type": "string" }, "location": { "description": "位置id", "type": "integer" }, "title": { "description": "广告标题", "type": "string" } } }, "pubdef.LoginType": { "type": "integer", "enum": [ 0, 1, 2 ], "x-enum-comments": { "LoginTypeAccount": "账号登陆", "LoginTypeDevice": "设备登陆", "LoginTypeEmail": "邮箱登陆" }, "x-enum-varnames": [ "LoginTypeDevice", "LoginTypeAccount", "LoginTypeEmail" ] }, "pubdef.SeoValue": { "type": "object", "properties": { "description": { "description": "网站SEO描述", "type": "string" }, "keyworld": { "description": "网站SEO关键字", "type": "array", "items": { "type": "string" } }, "title": { "description": "网站SEO标题", "type": "string" } } }, "pubdef.TranslationType": { "type": "integer", "enum": [ 1, 2, 3 ], "x-enum-comments": { "TranslationTypeBottom": "底部导航", "TranslationTypeSub": "二级导航", "TranslationTypeUrl": "URL模式" }, "x-enum-varnames": [ "TranslationTypeUrl", "TranslationTypeSub", "TranslationTypeBottom" ] }, "pubdef.UserStatus": { "type": "integer", "enum": [ 0, 1, 2 ], "x-enum-comments": { "UserStatusDisable": "封禁", "UserStatusNormal": "正常", "UserStatusSlient": "禁言" }, "x-enum-varnames": [ "UserStatusNormal", "UserStatusDisable", "UserStatusSlient" ] }, "pubdef.UserType": { "type": "integer", "enum": [ 0, 1, 0 ], "x-enum-comments": { "UserTypeGuest": "游客用户", "UserTypeNormal": "普通用户（已注册）" }, "x-enum-varnames": [ "UserTypeGuest", "UserTypeNormal", "UserTypeNone" ] }, "pubdef.VipOrderStatus": { "type": "integer", "enum": [ 1, 2, 3 ], "x-enum-comments": { "VipOrderFailed": "支付失败", "VipOrderPending": "待支付", "VipOrderSuccess": "支付成功" }, "x-enum-varnames": [ "VipOrderPending", "VipOrderSuccess", "VipOrderFailed" ] }, "pubdef.VipType": { "type": "integer", "enum": [ 0, 1, 2 ], "x-enum-comments": { "VipTypeMonth": "月卡", "VipTypeNone": "没卡", "VipTypeYear": "年卡" }, "x-enum-varnames": [ "VipTypeNone", "VipTypeMonth", "VipTypeYear" ] }, "rechargeapi.submitOrderReq": { "type": "object", "required": [ "packageId", "payMode" ], "properties": { "packageId": { "description": "购买套餐ID（会员畅享）", "type": "integer" }, "payMode": { "description": "支付方式：alipay/wechat", "type": "string" } } }, "rechargepackagemod.PackageType": { "type": "integer", "enum": [ 1, 2 ], "x-enum-comments": { "PackageTypeCoin": "金币充值", "PackageTypeVip": "会员畅享" }, "x-enum-varnames": [ "PackageTypeVip", "PackageTypeCoin" ] }, "rechargeser.SubmitOrderResp": { "type": "object", "properties": { "isOpenNewBrowser": { "description": "是否需要外部浏览器打开", "type": "boolean" }, "payUrl": { "description": "支付链接", "type": "string" }, "payUrlMode": { "description": "链接打开方式", "type": "string" }, "tradeNo": { "description": "本地订单号（可用于查询）", "type": "string" } } }, "response.BasePageResp": { "type": "object", "properties": { "list": { "description": "集合列表" }, "pageNum": { "description": "页数", "type": "integer" }, "pageSize": { "description": "每页数", "type": "integer" }, "totalCount": { "description": "总共数量", "type": "integer" } } }, "statcenter.AiSellMsg": { "type": "object", "properties": { "amount": { "type": "integer" }, "appID": { "type": "integer" }, "currencyType": { "type": "string" }, "devType": { "type": "string" }, "isRepurchase": { "type": "string" }, "sysType": { "type": "string" }, "tranCreatedAt": { "type": "string" }, "tranType": { "type": "string" }, "uid": { "type": "integer" }, "uniqID": { "type": "string" } } }, "statcenter.BuyVIPType": { "type": "integer", "enum": [ 0, 1 ], "x-enum-comments": { "BuyVIPTypeGold": "金币", "BuyVIPTypeMoney": "现金" }, "x-enum-varnames": [ "BuyVIPTypeMoney", "BuyVIPTypeGold" ] }, "statcenter.CardSellMsg": { "type": "object", "properties": { "amount": { "type": "integer" }, "appID": { "type": "integer" }, "currencyType": { "description": "0金币 1现金", "type": "integer" }, "product": { "$ref": "#/definitions/statcenter.Product" }, "sysType": { "type": "string" }, "tranCreatedAt": { "type": "string" }, "tranType": { "type": "string" }, "tranTypeInt": { "type": "integer" }, "uid": { "type": "integer" }, "uniqID": { "type": "string" } } }, "statcenter.ConsumeRecordMsg": { "type": "object", "properties": { "amount": { "description": "金币", "type": "number" }, "appID": { "type": "integer" }, "createdAt": { "type": "string" }, "currencyType": { "description": "0金币 1人民币", "type": "integer" }, "money": { "description": "人民币 元", "type": "number" }, "type": { "description": "消费类型", "type": "integer" }, "uid": { "type": "integer" }, "uniq": { "type": "string" } } }, "statcenter.Product": { "type": "object", "properties": { "discountedPrice": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "statcenter.StatcenterSyncReq": { "type": "object", "properties": { "job": { "description": "同步任务类型", "type": "string" }, "maxSize": { "description": "最大条数", "type": "integer" }, "platformId": { "description": "原始平台Id(访问/流水)", "type": "string" }, "successTime": { "description": "游标时间(购买会员、提现、充值)", "type": "string" }, "userId": { "description": "用户(注册)", "type": "integer" } } }, "statcenter.StatcenterSyncResp": { "type": "object", "properties": { "accessList": { "description": "日活记录", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserVisitMsg" } }, "aiSellList": { "description": "AI销售流水", "type": "array", "items": { "$ref": "#/definitions/statcenter.AiSellMsg" } }, "allRechargeList": { "description": "全部支付订单", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserRechargeMsg" } }, "bindingList": { "description": "用户绑定记录", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserBindingMsg" } }, "buyVipList": { "description": "VIP购买记录", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserBuyVIPMsg" } }, "cardSellList": { "description": "会员卡销售流水", "type": "array", "items": { "$ref": "#/definitions/statcenter.CardSellMsg" } }, "code": { "description": "200正常 其他异常", "type": "integer" }, "consumeList": { "description": "消费流水", "type": "array", "items": { "$ref": "#/definitions/statcenter.ConsumeRecordMsg" } }, "inviteList": { "description": "邀请绑定", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserInviteBindMsg" } }, "job": { "description": "类型", "type": "string" }, "msg": { "description": "错误消息", "type": "string" }, "rechargeList": { "description": "充值记录", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserRechargeMsg" } }, "registerList": { "description": "注册记录", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserRegisterMsg" } }, "visitList": { "description": "日活记录（旧字段，兼容）", "type": "array", "items": { "$ref": "#/definitions/statcenter.UserVisitMsg" } } } }, "statcenter.UserBindingMsg": { "type": "object", "properties": { "appId": { "description": "appID", "type": "integer" }, "bindingTime": { "description": "绑定时间", "type": "string" }, "devType": { "description": "设备类型", "type": "string" }, "mobile": { "description": "手机号/绑定账号（本项目填邮箱）", "type": "string" }, "platformId": { "description": "原始平台流水Id", "type": "string" }, "sysType": { "description": "操作系统类型", "type": "string" }, "userId": { "description": "用户ID", "type": "integer" } } }, "statcenter.UserBuyVIPMsg": { "type": "object", "properties": { "amount": { "type": "integer" }, "appId": { "type": "integer" }, "buyVIPType": { "$ref": "#/definitions/statcenter.BuyVIPType" }, "deviceType": { "type": "string" }, "districtCode": { "type": "string" }, "isDirect": { "type": "boolean" }, "money": { "type": "integer" }, "name": { "type": "string" }, "oid": { "type": "string" }, "platformId": { "type": "string" }, "promCode": { "type": "string" }, "status": { "type": "integer" }, "successTime": { "type": "string" }, "uid": { "type": "integer" } } }, "statcenter.UserInviteBindMsg": { "type": "object", "required": [ "appId", "inviteTime", "userId" ], "properties": { "appId": { "type": "integer" }, "inviteTime": { "type": "string" }, "parentPromCode": { "type": "string" }, "userId": { "type": "integer" } } }, "statcenter.UserRechargeMsg": { "type": "object", "required": [ "appId", "money", "orderId", "payMoney", "sysType", "userId" ], "properties": { "appId": { "type": "integer" }, "chanShareMod": { "type": "integer" }, "channelName": { "type": "string" }, "cid": { "type": "string" }, "createdAt": { "type": "string" }, "devType": { "type": "string" }, "districtCode": { "type": "string" }, "isNewOrOldUser": { "type": "boolean" }, "money": { "type": "integer" }, "oid": { "type": "string" }, "orderId": { "type": "string" }, "payMoney": { "type": "integer" }, "paymentAt": { "type": "string" }, "platformId": { "type": "string" }, "productType": { "type": "integer" }, "rate": { "type": "string" }, "registerTime": { "type": "string" }, "status": { "type": "integer" }, "successAt": { "type": "string" }, "sysType": { "type": "string" }, "type": { "type": "string" }, "userId": { "type": "integer" } } }, "statcenter.UserRegisterMsg": { "type": "object", "required": [ "appId", "isDirect", "registerTime", "sysType", "userId" ], "properties": { "appId": { "description": "appID", "type": "integer" }, "devType": { "description": "设备类型", "type": "string" }, "districtCode": { "description": "渠道码", "type": "string" }, "ip": { "description": "IP", "type": "string" }, "isDirect": { "description": "true:是直推用户", "type": "boolean" }, "mobile": { "description": "手机号", "type": "string" }, "name": { "description": "名称", "type": "string" }, "platformId": { "description": "原始平台流水Id", "type": "string" }, "promCode": { "description": "推广序列", "type": "string" }, "promSeqe": { "description": "全名代理", "type": "string" }, "puc": { "description": "应用中心推广", "type": "string" }, "registerTime": { "description": "注册时间", "type": "string" }, "sysType": { "description": "操作系统类型 安卓 IOS", "type": "string" }, "userId": { "description": "用户ID", "type": "integer" } } }, "statcenter.UserVisitMsg": { "type": "object", "properties": { "appId": { "description": "appID", "type": "integer" }, "devID": { "description": "设备ID", "type": "string" }, "devType": { "description": "设备型号", "type": "string" }, "districtCode": { "description": "渠道码", "type": "string" }, "ip": { "description": "IP", "type": "string" }, "isDirect": { "description": "true:是直推用户", "type": "boolean" }, "platformId": { "description": "原始平台流水Id", "type": "string" }, "registerTime": { "description": "用户注册时间", "type": "string" }, "sysType": { "description": "操作系统类型 安卓 IOS", "type": "string" }, "userId": { "description": "用户ID", "type": "integer" }, "version": { "description": "APP版本号", "type": "string" }, "visitAt": { "description": "访问时间", "type": "string" } } }, "uploadser.ImageUploadData": { "type": "object", "properties": { "id": { "type": "string" }, "sourceNameFs": { "type": "string" } } }, "uploadser.ImageUploadResp": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/uploadser.ImageUploadData" }, "hash": { "type": "boolean" }, "msg": { "type": "string" }, "time": { "type": "string" }, "tip": { "type": "string" } } }, "vipordermod.OrderType": { "type": "integer", "enum": [ 1, 2 ], "x-enum-comments": { "OrderTypeCoin": "金币购买", "OrderTypeVip": "会员购买" }, "x-enum-varnames": [ "OrderTypeVip", "OrderTypeCoin" ] }, "vipordermod.VipOrder": { "type": "object", "properties": { "amount": { "description": "支付金额（分）", "type": "integer" }, "baseCoin": { "description": "基础金币数（快照）", "type": "integer" }, "cardId": { "description": "── VIP 专用 ──", "type": "integer" }, "cardName": { "description": "套餐名快照", "type": "string" }, "coin": { "description": "到账金币数（快照）", "type": "integer" }, "coinCfgId": { "description": "── 金币专用 ──", "type": "integer" }, "createdAt": { "description": "创建时间", "type": "string" }, "districtCode": { "description": "下单时用户渠道码", "type": "string" }, "finishedAt": { "description": "完成时间", "type": "string" }, "giftCoin": { "description": "赠送金币数（快照）", "type": "integer" }, "id": { "description": "唯一ID", "type": "integer" }, "ipAddr": { "description": "客户端 IP", "type": "string" }, "oid": { "description": "第三方订单号", "type": "string" }, "orderType": { "description": "订单类型：1会员 2金币", "allOf": [ { "$ref": "#/definitions/vipordermod.OrderType" } ] }, "payChannel": { "description": "支付渠道", "type": "string" }, "payMode": { "description": "支付方式：overage/alipay/wechat", "type": "string" }, "payRate": { "description": "费率", "type": "string" }, "payUrl": { "description": "支付链接", "type": "string" }, "payUrlMode": { "description": "链接打开方式", "type": "string" }, "status": { "description": "订单状态", "allOf": [ { "$ref": "#/definitions/pubdef.VipOrderStatus" } ] }, "sysType": { "description": "ios/android", "type": "string" }, "tradeNo": { "description": "本地订单号", "type": "string" }, "updatedAt": { "description": "更新时间", "type": "string" }, "userId": { "description": "用户ID", "type": "integer" } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "name": "Authorization", "in": "header" }, "BasicAuth": { "type": "basic" }, "OAuth2AccessCode": { "type": "oauth2", "flow": "accessCode", "authorizationUrl": "https://example.com/oauth/authorize", "tokenUrl": "https://example.com/oauth/token", "scopes": { "admin": "Grants read and write access to administrative information" } }, "OAuth2Application": { "type": "oauth2", "flow": "application", "tokenUrl": "https://example.com/oauth/token", "scopes": { "admin": "Grants read and write access to administrative information", "write": "Grants write access" } }, "OAuth2Implicit": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://example.com/oauth/authorize", "scopes": { "admin": "Grants read and write access to administrative information", "write": "Grants write access" } }, "OAuth2Password": { "type": "oauth2", "flow": "password", "tokenUrl": "https://example.com/oauth/token", "scopes": { "admin": "Grants read and write access to administrative information", "read": "Grants read access", "write": "Grants write access" } } } }` // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "1.0", Host: "https://视频站-api.lcncctn.com", BasePath: "/", Schemes: []string{"http", "https"}, Title: "视频站APP接口", Description: "这是视频站APP接口服务.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }