Files
web_hghl_server/app/docs/swagger.yaml
T
2026-10-26 16:28:14 +08:00

4418 lines
113 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
basePath: /
definitions:
actress.Meas:
properties:
blood:
description: 血型
type: string
bust:
description: 胸围 英寸
type: integer
cup:
description: 罩杯(A:1-G:9)1表示A,2表示B,3表示C,4表示D,5表示E,6表示F,7表示G,8表示H,9表示I
type: integer
dia:
description: 直径 毫米(前端可以显示为厘米,如45毫米,显示为4.5厘米,返回后端时,乘以10,保留整数,返回45)
type: integer
gender:
description: 性别 0:女 1:男 2:其他
type: integer
height:
description: 身高 厘米
type: integer
hip:
description: 臀围 英寸
type: integer
len:
description: 长度 毫米(前端可以显示为厘米,如145毫米,显示为14.5厘米,返回后端时,乘以10,保留整数,返回145)
type: integer
waist:
description: 腰围 英寸
type: integer
weight:
description: 体重 公斤
type: integer
type: object
authapi.guestLoginReq:
properties:
devID:
description: 设备 ID(首选)
type: string
deviceId:
description: 设备 ID 第二版本(备用)
type: string
mac:
description: 设备 MAC 地址(备用)
type: string
type: object
authapi.loginReq:
properties:
account:
description: 账号
type: string
password:
description: 明文密码
type: string
required:
- account
- password
type: object
authapi.registerReq:
properties:
accountNo:
description: 账号
type: string
agentInviteCode:
description: 邀请人的邀请码(可选)
type: string
password:
description: 明文密码
type: string
required:
- accountNo
- password
type: object
authapi.updateProfileReq:
properties:
accountNo:
description: 账号(必填,用于定位用户)
type: string
avatar:
description: 新头像 URL(可选)
type: string
newPassword:
description: 新密码明文(修改密码时必填)
type: string
nikeName:
description: 昵称
type: string
oldPassword:
description: 旧密码明文(修改密码时必填)
type: string
required:
- accountNo
type: object
authser.LoginResp:
properties:
accountNo:
type: string
avatar:
description: 头像
type: string
inviteCode:
description: 邀请码
type: string
isNewUser:
description: 是否本次请求新创建的用户
type: boolean
isRegister:
description: 是否已完成账号注册
type: boolean
loginType:
allOf:
- $ref: '#/definitions/pubdef.LoginType'
description: 登录方式 0=设备 3=账号
nickName:
type: string
recharge:
description: 当前金币个数
type: integer
status:
$ref: '#/definitions/pubdef.UserStatus'
token:
type: string
userId:
type: integer
type: object
authser.UserInfoResp:
properties:
accountNo:
type: string
avatar:
type: string
inviteCode:
type: string
isRegister:
type: boolean
loginType:
$ref: '#/definitions/pubdef.LoginType'
nickName:
type: string
recharge:
type: integer
status:
$ref: '#/definitions/pubdef.UserStatus'
userId:
type: integer
type: object
contenttagmod.ContentTagType:
enum:
- 1
- 5
type: integer
x-enum-comments:
ContentTagTypePlaylet: 短剧
ContentTagTypeVideo: 视频
x-enum-varnames:
- ContentTagTypeVideo
- ContentTagTypePlaylet
playletchaptermod.PayType:
enum:
- 0
- 1
- 2
type: integer
x-enum-comments:
PayTypeCoin: 金币
PayTypeFree: 免费
PayTypeVip: VIP
x-enum-varnames:
- PayTypeFree
- PayTypeCoin
- PayTypeVip
playletchaptermod.WatermarkStatus:
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
x-enum-comments:
WatermarkStatusDone: 已完成
WatermarkStatusFailed: 处理失败
WatermarkStatusPending: 未处理(待 mediafile/sync)
WatermarkStatusProcessing: 处理中(已提交加水印任务,待回写)
WatermarkStatusRegistered: 已登记(原片已登记,待 task/add)
x-enum-varnames:
- WatermarkStatusPending
- WatermarkStatusRegistered
- WatermarkStatusProcessing
- WatermarkStatusDone
- WatermarkStatusFailed
playletmod.ContentType:
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
x-enum-comments:
ContentTypeAlbum: 普通短剧/影集(对应 media_type=6)
ContentTypeAnime: 动漫(对应 media_type=1)
ContentTypeComic: 漫画短剧(对应 media_type=4)
ContentTypeManga: 漫画(对应 media_type=2)
ContentTypeTheater: 短剧(对应 media_type=5)
x-enum-varnames:
- ContentTypeTheater
- ContentTypeAlbum
- ContentTypeComic
- ContentTypeAnime
- ContentTypeManga
playletmod.PayType:
enum:
- 0
- 1
- 2
type: integer
x-enum-comments:
PayTypeCoin: 金币
PayTypeFree: 免费
PayTypeVip: VIP
x-enum-varnames:
- PayTypeFree
- PayTypeCoin
- PayTypeVip
playletmod.Status:
enum:
- 0
- 1
type: integer
x-enum-comments:
StatusDown: 下架
StatusUp: 上架
x-enum-varnames:
- StatusDown
- StatusUp
proto.ActressInfo:
properties:
alias:
description: 别名
type: string
avatar:
description: 头像
type: string
hotValue:
description: 热度值
type: integer
id:
description: Id
type: integer
slug:
description: slug
type: string
works:
description: 作品数
type: integer
type: object
proto.ActressInfoData:
properties:
alias:
description: 别名
type: string
avatar:
description: 头像
type: string
bornDate:
description: 出生日期
type: string
comments:
description: 评论条数
type: integer
cover:
description: 封面大图
type: string
debutDate:
description: 出道日期
type: string
desc:
description: 详细描述
type: string
hotValue:
description: 热度值
type: integer
id:
description: Id
type: integer
meas:
allOf:
- $ref: '#/definitions/actress.Meas'
description: 三围
measValue:
description: 三围值
type: string
office:
description: 事务所
type: string
region:
description: 地区/国家
type: string
score:
description: 评分
type: string
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
showTimes:
description: 展示次数
type: integer
slug:
description: slug
type: string
watchTimes:
description: 观看次数
type: integer
works:
description: 作品数
type: integer
type: object
proto.AdvitiseData:
properties:
AList:
description: 固定12广告位
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
BList:
description: 固定13广告位
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
detailTopList:
description: 详情页顶部广告
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
detailbannerList:
description: 详情banner
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
dialogList:
description: 弹窗广告
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
floatingList:
description: 悬浮小方块
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
friendList:
description: 友链
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
homeList:
description: 首页列表
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
launchScreenList:
description: 启动页广告
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
mustAppList:
description: 必备精品
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
nineGridList:
description: 9宫格
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
postList:
description: 列表穿插广告(视频、短剧、女优列表使用)
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
titleAppList:
description: 标题广告(APP名称)
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
videoList:
description: 视频列表
items:
$ref: '#/definitions/proxy.AdvitiseInfo'
type: array
type: object
proto.AnnouncementInfo:
properties:
appAddr:
description: 吃瓜app (免费吃瓜 每日更新)
type: string
foreverUrlAddr:
description: 永久海外地址(翻墙访问 永不迷路)
type: string
newUrlAddr:
description: 新国内地址
type: string
newUrlAddr1:
description: 备用地址1
type: string
newUrlAddr2:
description: 备用地址1
type: string
pdfAddr:
description: 回家的路PDF
type: string
translationAddr:
description: 应用导航
type: string
videoInfo:
description: 热门信息
items:
$ref: '#/definitions/proto.VideoInfoData'
type: array
type: object
proto.AppCategoryInfo:
properties:
appList:
description: 应用列表
items:
$ref: '#/definitions/proto.AppInfoData'
type: array
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
type: object
proto.AppContentTagItem:
properties:
bindCount:
description: 当前查询类型绑定数量,不传type时为各类型绑定数量合计
type: integer
id:
description: 标签ID
type: integer
name:
description: 标签名称
type: string
playletCount:
description: 绑定短剧数量
type: integer
rank:
description: 排序
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
types:
description: 支持类型 1-视频 5-短剧
items:
$ref: '#/definitions/contenttagmod.ContentTagType'
type: array
videoCount:
description: 绑定视频数量
type: integer
type: object
proto.AppContentTagListResp:
properties:
list:
description: 统一标签列表
items:
$ref: '#/definitions/proto.AppContentTagItem'
type: array
type: object
proto.AppInfoData:
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
type: object
proto.AppListResp:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部导航
category:
allOf:
- $ref: '#/definitions/proto.AppCategoryInfo'
description: 当前分类(含应用列表)
categoryList:
description: 应用分类列表(含各分类下的应用列表)
items:
$ref: '#/definitions/proto.AppCategoryInfo'
type: array
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置信息
path:
description: 当前路径
type: string
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.AppRichTextItemResp:
properties:
content:
description: 内容
type: string
desc:
description: 标题(app)
type: string
id:
description: 富文本ID
type: integer
title:
description: 标题
type: string
type: object
proto.AppRichTextListResp:
properties:
list:
description: 富文本内容列表
items:
$ref: '#/definitions/proto.AppRichTextItemResp'
type: array
type: object
proto.AppTranslationInfo:
properties:
categoryList:
items:
$ref: '#/definitions/proto.TranslationCategory'
type: array
type: object
proto.CommentInfo:
properties:
avatar:
description: 用户头像
type: string
commentCount:
description: 该评论回复数量
type: integer
createdAt:
description: 创建时间
type: string
id:
description: 评论ID
type: integer
level:
description: 评论级别
type: integer
objectId:
description: 对象ID
type: integer
parentsId:
description: 上级评论ID
type: integer
replyUserName:
description: 回复名称
type: string
subComment:
description: 子评论
items:
$ref: '#/definitions/proto.CommentInfo'
type: array
text:
description: 评论内容
type: string
userName:
description: 用户名称
type: string
type: object
proto.CommentListResp:
properties:
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
type: object
proto.CommentSendReq:
properties:
objectId:
description: 对象ID
type: integer
objectType:
allOf:
- $ref: '#/definitions/pubdef.CommentObjectType'
description: 对象类型 0=视频 4=短剧
parentsId:
description: 上级评论ID
type: integer
text:
description: 评论内容
type: string
type: object
proto.ConfigInfo:
properties:
appAddr:
description: APP下载地址(落地页)
type: string
channelCode:
description: 渠道码
type: string
dhDescription:
description: 导航SEO描述
type: string
dhKeyworld:
description: 导航SEO关键字
items:
type: string
type: array
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
m3u8DayRateLimitMax:
description: 每 IP 每天最多不同正片数
type: integer
mediaAppUsCdn:
description: 视频CDN(海外app使用)
type: string
newUrlAddr:
description: 最新地址
type: string
newUrlAddr1:
description: 最新地址(备用地址1)
type: string
newUrlAddr2:
description: 最新地址(备用地址2)
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: 所有使用中的域名
items:
type: string
type: array
webAddr:
description: 网站SEO网站地址
type: string
webDescription:
description: 网站SEO描述
type: string
webKeyworld:
description: 网站SEO关键字
items:
type: string
type: array
webSiteName:
description: 网站SEO网站名称
type: string
webTitle:
description: 网站SEO标题
type: string
weiChart:
description: 微信群
type: string
type: object
proto.ContentData:
properties:
addedTime:
description: 上架时间
type: string
coverImg:
description: 封面
type: string
id:
description: id
type: integer
likeNum:
description: 点赞(收藏)数(真假点赞(收藏)数之和)
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
tags:
description: 标签id
items:
type: integer
type: array
tagsName:
description: 标签名称
items:
type: string
type: array
title:
description: 标题
type: string
watchNum:
description: 观看数(真假观看数之和)
type: integer
type: object
proto.DHHtmlData:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部导航
completePath:
type: string
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置文件
hotNavs:
description: 热门导航
items:
$ref: '#/definitions/proto.HotNavItem'
type: array
hotSearch:
description: 热搜
items:
$ref: '#/definitions/proto.HotSearchItem'
type: array
path:
type: string
richTextInfo:
allOf:
- $ref: '#/definitions/proto.RichTextInfo'
description: 富文本
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.DataResp:
properties:
actressInfoList:
description: 女优信息
items:
$ref: '#/definitions/proto.ActressInfo'
type: array
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置信息
homeBannerList:
description: 首页banner信息列表
items:
$ref: '#/definitions/proto.HomeBannerInfo'
type: array
path:
description: 当前路径
type: string
playletData:
allOf:
- $ref: '#/definitions/proto.HomePlayletDataResp'
description: 首页短剧数据
videoData:
allOf:
- $ref: '#/definitions/proto.HomeVideoDataResp'
description: 首页视频数据
type: object
proto.FavoriteVideoListItem:
properties:
addedTime:
description: 上架时间
type: string
coverImg:
description: 封面
type: string
id:
description: id
type: integer
likeNum:
description: 点赞(收藏)数(真假点赞(收藏)数之和)
type: integer
slug:
description: slug
type: string
tags:
description: 标签id
items:
type: integer
type: array
tagsName:
description: 标签名称
items:
type: string
type: array
title:
description: 标题
type: string
watchNum:
description: 观看数(真假观看数之和)
type: integer
type: object
proto.FavoriteVideoReq:
properties:
id:
description: ID
type: integer
isFavorite:
description: 是否收藏,true-收藏、false-取消收藏
type: boolean
required:
- id
- isFavorite
type: object
proto.FavoriteVideoResp:
properties:
id:
description: ID
type: integer
isFavorite:
description: 是否收藏,true-收藏、false-取消收藏
type: boolean
type: object
proto.FooterBrand:
properties:
content:
description: 品牌标语
type: string
title:
description: 品牌标题
type: string
type: object
proto.FooterContact:
properties:
name:
description: 联系方式名称
type: string
value:
description: 联系方式值
type: string
type: object
proto.FooterInfo:
properties:
brand:
allOf:
- $ref: '#/definitions/proto.FooterBrand'
description: 品牌信息
contactList:
description: 联系方式
items:
$ref: '#/definitions/proto.FooterContact'
type: array
navList:
description: 底部导航
items:
$ref: '#/definitions/proto.TranslationCategory'
type: array
type: object
proto.FooterInfoResp:
properties:
footerInfo:
allOf:
- $ref: '#/definitions/proto.FooterInfo'
description: 底部信息
type: object
proto.HomeBannerInfo:
properties:
id:
description: ID
type: integer
image:
description: 图片,已拼接图片域名
type: string
name:
description: 名称
type: string
rank:
description: 排序
type: integer
status:
description: 状态 true-启用 false-停用
type: boolean
url:
description: URL
type: string
verticalImage:
description: 竖版图片,已拼接图片域名
type: string
type: object
proto.HomeBaseResp:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置信息
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.HomeHtmlData:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部导航
completePath:
description: 请求路径
type: string
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置文件
hotSearch:
description: 热搜
items:
$ref: '#/definitions/proto.HotSearchItem'
type: array
path:
type: string
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.HomePlayletDataResp:
properties:
hotList:
description: 最热短剧列表
items:
$ref: '#/definitions/proto.PlayletData'
type: array
newestList:
description: 最新短剧列表
items:
$ref: '#/definitions/proto.PlayletData'
type: array
recommendList:
description: 推荐短剧列表
items:
$ref: '#/definitions/proto.PlayletData'
type: array
type: object
proto.HomeRankData:
properties:
month:
description: 月榜
items:
$ref: '#/definitions/proto.ContentData'
type: array
total:
description: 总榜
items:
$ref: '#/definitions/proto.ContentData'
type: array
week:
description: 周榜
items:
$ref: '#/definitions/proto.ContentData'
type: array
year:
description: 年榜
items:
$ref: '#/definitions/proto.ContentData'
type: array
type: object
proto.HomeTagsResp:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置信息
playletTagsList:
description: 短剧标签
items:
$ref: '#/definitions/proto.TagsInfoData'
type: array
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
videoTagsList:
description: 视频标签
items:
$ref: '#/definitions/proto.TagsInfoData'
type: array
type: object
proto.HomeVideoDataResp:
properties:
hotList:
description: 最热视频列表
items:
$ref: '#/definitions/proto.VideoInfo'
type: array
newestList:
description: 最新视频列表
items:
$ref: '#/definitions/proto.VideoInfo'
type: array
recommendList:
description: 推荐视频列表
items:
$ref: '#/definitions/proto.VideoInfo'
type: array
type: object
proto.HotNavItem:
properties:
icon:
description: 图标
type: string
id:
description: ID
type: integer
intro:
description: 介绍
type: string
title:
description: 标题
type: string
url:
description: 链接
type: string
type: object
proto.HotSearchItem:
properties:
hotValue:
description: 热度值
type: integer
id:
description: ID
type: integer
title:
description: 标题
type: string
type: object
proto.LawAndTrustHtmlData:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部导航
completePath:
type: string
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置文件
hotSearch:
description: 热搜
items:
$ref: '#/definitions/proto.HotSearchItem'
type: array
path:
type: string
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.LikePlayletReq:
properties:
id:
description: ID
type: integer
isLike:
description: 是否点赞,true-点赞、false-取消点赞
type: boolean
required:
- id
- isLike
type: object
proto.LikePlayletResp:
properties:
id:
description: ID
type: integer
isLike:
description: 是否点赞,true-点赞、false-取消点赞
type: boolean
likeNum:
description: 点赞数(真实点赞数加后台虚拟点赞数)
type: integer
type: object
proto.LikeVideoReq:
properties:
id:
description: ID
type: integer
isLike:
description: 是否点赞,true-点赞、false-取消点赞
type: boolean
required:
- id
- isLike
type: object
proto.LikeVideoResp:
properties:
id:
description: ID
type: integer
isLike:
description: 是否点赞,true-点赞、false-取消点赞
type: boolean
likeNum:
description: 点赞数(真假点赞数之和)
type: integer
type: object
proto.PlayletChapterInfo:
properties:
countBrowse:
description: 浏览数
type: integer
countCollect:
description: 收藏数
type: integer
countLike:
description: 喜欢数
type: integer
createdAt:
description: 创建时间
type: string
currentEpisode:
description: 第几集
type: integer
hash:
description: 媒体hash
type: string
height:
description: 高
type: integer
id:
description: 剧集ID
type: integer
md5:
description: 媒体md5
type: string
mediaContentId:
description: 媒资中心章节ID
type: integer
mediaSize:
description: 资源大小
type: integer
mediaTime:
description: 影片长度(秒)
type: integer
payType:
allOf:
- $ref: '#/definitions/playletchaptermod.PayType'
description: 支付方式 0-免费 1-金币 2-VIP
playletId:
description: 短剧ID
type: integer
ratio:
description: 宽高比
type: number
singleCoins:
description: 单集金币
type: integer
title:
description: 章节名
type: string
updatedAt:
description: 修改时间
type: string
videoUrl:
description: 视频播放地址,优先返回水印地址
type: string
watermarkStatus:
allOf:
- $ref: '#/definitions/playletchaptermod.WatermarkStatus'
description: 水印状态 0-未处理 1-已登记 2-处理中 3-已完成
width:
description: 宽
type: integer
type: object
proto.PlayletData:
properties:
anchor:
description: 作者或演员
type: string
contentType:
allOf:
- $ref: '#/definitions/playletmod.ContentType'
description: 内容类型 0-短剧 1-普通短剧影集 2-漫画短剧 3-动漫 4-漫画
countBrowse:
description: 累计点击量
type: integer
countCollect:
description: 收藏数
type: integer
countLike:
description: 真实点赞数
type: integer
cover:
description: 封面,已拼接图片域名
type: string
createdAt:
description: 创建时间
type: string
desc:
description: 简介
type: string
displayCountLike:
description: 展示点赞数,真实点赞数加后台虚拟点赞数
type: integer
heatValue:
description: 热度值
type: integer
id:
description: 短剧id
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
payType:
allOf:
- $ref: '#/definitions/playletmod.PayType'
description: 支付方式 0-免费 1-金币 2-VIP
preview:
description: 预告,已拼接图片域名
type: string
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
singleCoins:
description: 单集金币,支付方式为金币时生效
type: integer
slug:
description: slug
type: string
status:
allOf:
- $ref: '#/definitions/playletmod.Status'
description: 状态 0-下架 1-上架
tagIds:
description: 标签ID集合
items:
type: integer
type: array
tagNames:
description: 标签名称集合
items:
type: string
type: array
themeIds:
description: 题材ID集合
items:
type: integer
type: array
themeNames:
description: 题材名称集合
items:
type: string
type: array
title:
description: 标题
type: string
totalEpisode:
description: 总集数
type: integer
updateStatus:
description: 更新状态 1-连载中 2-已完结
type: integer
updatedAt:
description: 修改时间
type: string
virtualCountLike:
description: 后台虚拟点赞数
type: integer
type: object
proto.PlayletDetailInfo:
properties:
anchor:
description: 作者或演员
type: string
contentType:
allOf:
- $ref: '#/definitions/playletmod.ContentType'
description: 内容类型 0-短剧 1-普通短剧影集 2-漫画短剧 3-动漫 4-漫画
countBrowse:
description: 累计点击量
type: integer
countCollect:
description: 收藏数
type: integer
countComment:
description: 评论数量
type: integer
countLike:
description: 真实点赞数
type: integer
cover:
description: 封面,已拼接图片域名
type: string
createdAt:
description: 创建时间
type: string
desc:
description: 简介
type: string
displayCountLike:
description: 展示点赞数,真实点赞数加后台虚拟点赞数
type: integer
heatValue:
description: 热度值
type: integer
id:
description: 短剧id
type: integer
isLike:
description: 当前登录用户是否已点赞该短剧
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
payType:
allOf:
- $ref: '#/definitions/playletmod.PayType'
description: 支付方式 0-免费 1-金币 2-VIP
preview:
description: 预告,已拼接图片域名
type: string
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
singleCoins:
description: 单集金币,支付方式为金币时生效
type: integer
slug:
description: slug
type: string
status:
allOf:
- $ref: '#/definitions/playletmod.Status'
description: 状态 0-下架 1-上架
tagIds:
description: 标签ID集合
items:
type: integer
type: array
tagNames:
description: 标签名称集合
items:
type: string
type: array
themeIds:
description: 题材ID集合
items:
type: integer
type: array
themeNames:
description: 题材名称集合
items:
type: string
type: array
title:
description: 标题
type: string
totalEpisode:
description: 总集数
type: integer
updateStatus:
description: 更新状态 1-连载中 2-已完结
type: integer
updatedAt:
description: 修改时间
type: string
virtualCountLike:
description: 后台虚拟点赞数
type: integer
type: object
proto.PlayletRankData:
properties:
anchor:
description: 作者或演员
type: string
contentType:
allOf:
- $ref: '#/definitions/playletmod.ContentType'
description: 内容类型 0-短剧 1-普通短剧影集 2-漫画短剧 3-动漫 4-漫画
countBrowse:
description: 累计点击量
type: integer
countCollect:
description: 收藏数
type: integer
countLike:
description: 真实点赞数
type: integer
cover:
description: 封面,已拼接图片域名
type: string
createdAt:
description: 创建时间
type: string
desc:
description: 简介
type: string
displayCountLike:
description: 展示点赞数,真实点赞数加后台虚拟点赞数
type: integer
heatValue:
description: 热度值
type: integer
id:
description: 短剧id
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
payType:
allOf:
- $ref: '#/definitions/playletmod.PayType'
description: 支付方式 0-免费 1-金币 2-VIP
preview:
description: 预告,已拼接图片域名
type: string
rankScore:
description: 榜单分数,点赞榜为累计展示点赞数,周/月/年榜为对应周期观看数
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
singleCoins:
description: 单集金币,支付方式为金币时生效
type: integer
slug:
description: slug
type: string
status:
allOf:
- $ref: '#/definitions/playletmod.Status'
description: 状态 0-下架 1-上架
tagIds:
description: 标签ID集合
items:
type: integer
type: array
tagNames:
description: 标签名称集合
items:
type: string
type: array
themeIds:
description: 题材ID集合
items:
type: integer
type: array
themeNames:
description: 题材名称集合
items:
type: string
type: array
title:
description: 标题
type: string
totalEpisode:
description: 总集数
type: integer
updateStatus:
description: 更新状态 1-连载中 2-已完结
type: integer
updatedAt:
description: 修改时间
type: string
virtualCountLike:
description: 后台虚拟点赞数
type: integer
type: object
proto.PlayletRankResp:
properties:
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.PlayletRecommendItemType:
enum:
- 0
- 2
type: integer
x-enum-comments:
PlayletRecommendItemTypeAdvertise: 广告数据
PlayletRecommendItemTypePlaylet: 短剧数据
x-enum-varnames:
- PlayletRecommendItemTypePlaylet
- PlayletRecommendItemTypeAdvertise
proto.PlayletRecommendListItem:
properties:
advertiseId:
description: 广告ID,type=2时返回
type: string
anchor:
description: 作者或演员
type: string
contentType:
allOf:
- $ref: '#/definitions/playletmod.ContentType'
description: 内容类型 0-短剧 1-普通短剧影集 2-漫画短剧 3-动漫 4-漫画
countBrowse:
description: 累计点击量
type: integer
countCollect:
description: 收藏数
type: integer
countLike:
description: 真实点赞数
type: integer
cover:
description: 封面,已拼接图片域名
type: string
createdAt:
description: 创建时间
type: string
desc:
description: 简介
type: string
displayCountLike:
description: 展示点赞数,真实点赞数加后台虚拟点赞数
type: integer
heatValue:
description: 热度值
type: integer
id:
description: 短剧id
type: integer
isNew:
description: 是否上新 本周内上架为true
type: boolean
isRecommend:
description: 是否推荐 true-推荐 false-不推荐
type: boolean
link:
description: 广告跳转链接,type=2时返回
type: string
location:
description: 广告位置ID,type=2时返回
type: integer
mediaCreatedAt:
description: 媒资中心创建时间
type: string
mediaUpdatedAt:
description: 媒资中心更新时间
type: string
onlineAt:
description: 上架时间
type: string
payType:
allOf:
- $ref: '#/definitions/playletmod.PayType'
description: 支付方式 0-免费 1-金币 2-VIP
preview:
description: 预告,已拼接图片域名
type: string
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
singleCoins:
description: 单集金币,支付方式为金币时生效
type: integer
slug:
description: slug
type: string
status:
allOf:
- $ref: '#/definitions/playletmod.Status'
description: 状态 0-下架 1-上架
tagIds:
description: 标签ID集合
items:
type: integer
type: array
tagNames:
description: 标签名称集合
items:
type: string
type: array
themeIds:
description: 题材ID集合
items:
type: integer
type: array
themeNames:
description: 题材名称集合
items:
type: string
type: array
title:
description: 标题
type: string
totalEpisode:
description: 总集数
type: integer
type:
allOf:
- $ref: '#/definitions/proto.PlayletRecommendItemType'
description: 数据类型 0-短剧数据 2-广告
updateStatus:
description: 更新状态 1-连载中 2-已完结
type: integer
updatedAt:
description: 修改时间
type: string
virtualCountLike:
description: 后台虚拟点赞数
type: integer
type: object
proto.PlayletRecommendListResp:
properties:
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
type: object
proto.PostCreateInfo:
properties:
background:
description: 背景
type: string
createType:
description: 创作者类型 0=普通 1=官方
type: integer
createdAt:
description: 创建时间
type: string
desc:
description: 作者描述
type: string
id:
type: integer
image:
description: 头像
type: string
name:
type: string
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
works:
type: integer
type: object
proto.QueryActressListResp:
properties:
actressInfoList:
description: 女优列表
items:
$ref: '#/definitions/proto.ActressInfoData'
type: array
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部导航
path:
description: 当前路径
type: string
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.QueryActressWorkListResp:
properties:
actressInfo:
allOf:
- $ref: '#/definitions/proto.ActressInfoData'
description: 女优信息
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.QueryFavoriteVideoListResp:
properties:
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.QueryPlayletChapterInfoResp:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
chapterInfo:
allOf:
- $ref: '#/definitions/proto.PlayletChapterInfo'
description: 当前剧集详情
chapterList:
description: 剧集列表
items:
$ref: '#/definitions/proto.PlayletChapterInfo'
type: array
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置信息
hotPlayletList:
description: 热门短剧列表
items:
$ref: '#/definitions/proto.PlayletData'
type: array
isLike:
description: 当前登录用户是否已点赞该短剧
type: boolean
path:
description: 当前路径
type: string
playletInfo:
allOf:
- $ref: '#/definitions/proto.PlayletData'
description: 所属短剧详情
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.QueryPlayletInfoResp:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
chapterList:
description: 剧集列表
items:
$ref: '#/definitions/proto.PlayletChapterInfo'
type: array
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置信息
hotPlayletList:
description: 热门短剧列表
items:
$ref: '#/definitions/proto.PlayletData'
type: array
isLike:
description: 当前登录用户是否已点赞该短剧
type: boolean
path:
description: 当前路径
type: string
playletInfo:
allOf:
- $ref: '#/definitions/proto.PlayletDetailInfo'
description: 短剧详情数据
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.QueryVideoInfoResp:
properties:
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
announcement:
allOf:
- $ref: '#/definitions/proto.AnnouncementInfo'
description: 公告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置信息
hotVideoList:
description: 热门视频列表
items:
$ref: '#/definitions/proto.VideoData'
type: array
isFavorite:
description: 当前登录用户是否已收藏该视频
type: boolean
isLike:
description: 当前登录用户是否已点赞该视频
type: boolean
path:
description: 当前路径
type: string
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
videoInfo:
allOf:
- $ref: '#/definitions/proto.VideoDetailInfo'
description: 视频详情数据
type: object
proto.QueryVideoItemType:
enum:
- 0
- 2
type: integer
x-enum-varnames:
- QueryVideoItemTypeVideo
- QueryVideoItemTypeAdvertise
proto.QueryVideoListItem:
properties:
addedTime:
description: 上架时间
type: string
advertiseId:
description: 广告ID,type=2时返回
type: string
coverImg:
description: 封面
type: string
id:
description: id
type: integer
likeNum:
description: 点赞(收藏)数(真假点赞(收藏)数之和)
type: integer
link:
description: 广告跳转链接,type=2时返回
type: string
location:
description: 广告位置ID,type=2时返回
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
tags:
description: 标签id
items:
type: integer
type: array
tagsName:
description: 标签名称
items:
type: string
type: array
title:
description: 标题
type: string
type:
allOf:
- $ref: '#/definitions/proto.QueryVideoItemType'
description: 数据类型:0-视频数据、2-广告
watchNum:
description: 观看数(真假观看数之和)
type: integer
type: object
proto.QueryVideoResp:
properties:
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
categoryInfo:
allOf:
- $ref: '#/definitions/proto.VideoCategoryInfo'
description: 当前分类信息(含 SEO)
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.QuestionnaireSubmitReq:
properties:
attachments:
description: 附件列表,最多3个(选填)
items:
$ref: '#/definitions/questionnairemod.Attachment'
type: array
city:
description: 所在城市(选填)
type: string
contact:
description: 联系方式(选填)
type: string
description:
description: 问题描述(必填)
type: string
deviceModel:
description: 设备型号(选填)
type: string
deviceType:
description: 设备类型:iPhone、Android、iPad、其他
type: string
frequency:
description: 出现频率:每次都会、经常出现、偶尔出现、仅现一次
type: string
networkType:
description: 网络类型:WI-FI、5G、4G、其他
type: string
operator:
description: 运营商:电信、联通、移动、广电
type: string
province:
description: 所在省份(必填)
type: string
questionType:
description: 问题类型:播放卡顿/缓冲、无法播放、画质模糊、音画不同步、加载失败、闪退/崩溃、登录异常、其他问题
type: string
userId:
description: 登录用户ID,0表示匿名(选填)
type: integer
required:
- description
- deviceType
- frequency
- networkType
- operator
- province
- questionType
type: object
proto.RankResp:
properties:
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部导航
rankData:
$ref: '#/definitions/proto.HomeRankData'
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.RichTextInfo:
properties:
content:
description: 内容
type: string
desc:
description: 标题(app)
type: string
id:
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
title:
description: 标题
type: string
type: object
proto.SearchResp:
properties:
actress:
description: 女优资源
items:
$ref: '#/definitions/proto.ActressInfoData'
type: array
advitise:
allOf:
- $ref: '#/definitions/proto.AdvitiseData'
description: 广告
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部导航
completePath:
type: string
config:
allOf:
- $ref: '#/definitions/proto.ConfigInfo'
description: 配置文件
hotSearch:
description: 热搜
items:
$ref: '#/definitions/proto.HotSearchItem'
type: array
inTitle:
description: 输入标题
type: string
inType:
description: 输入类型 -1=全部 0=视频 1=女优 3=AV 6=短剧
type: integer
media:
description: 视频资源
items:
$ref: '#/definitions/proto.VideoInfoData'
type: array
pageNum:
type: integer
pageSize:
type: integer
path:
type: string
playlets:
description: 短剧资源
items:
$ref: '#/definitions/proto.PlayletData'
type: array
searchRecommend:
description: 搜索推荐
items:
type: string
type: array
sorts:
description: 排序选项
items:
$ref: '#/definitions/proto.SearchSortItem'
type: array
totalSize:
type: integer
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.SearchSortItem:
properties:
key:
description: 值
type: string
title:
description: 标题
type: string
type: object
proto.TagsInfoData:
properties:
id:
type: integer
images:
description: 背景
type: string
name:
description: 帖子标题
type: string
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
works:
description: 作品数量
type: integer
type: object
proto.TranslationCategory:
properties:
categoryType:
allOf:
- $ref: '#/definitions/pubdef.TranslationType'
description: 导航类型
icon:
description: Icon
type: string
id:
type: integer
name:
description: 名称
type: string
translationList:
items:
$ref: '#/definitions/proto.TranslationInfo'
type: array
urlValue:
description: URl路径
type: string
type: object
proto.TranslationInfo:
properties:
displayMode:
allOf:
- $ref: '#/definitions/pubdef.DisplayMode'
description: 展示方式
id:
description: ID
type: integer
isFriendAds:
description: 是否是友链广告位
type: boolean
name:
description: 名称
type: string
urlValue:
description: URl路径
type: string
type: object
proto.VideoCategoryInfo:
properties:
desc:
description: 描述
type: string
id:
type: integer
name:
type: string
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
title:
description: APP显示
type: string
type: object
proto.VideoData:
properties:
addedTime:
description: 上架时间
type: string
coverImg:
description: 封面
type: string
id:
description: id
type: integer
likeNum:
description: 点赞(收藏)数(真假点赞(收藏)数之和)
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
tags:
description: 标签id
items:
type: integer
type: array
tagsName:
description: 标签名称
items:
type: string
type: array
title:
description: 标题
type: string
watchNum:
description: 观看数(真假观看数之和)
type: integer
type: object
proto.VideoDetailInfo:
properties:
addedTime:
description: 上架时间
type: string
coverImg:
description: 封面
type: string
desc:
description: 作品简介
type: string
id:
description: id
type: integer
isFavorite:
description: 当前登录用户是否已收藏该视频
type: boolean
isLike:
description: 当前登录用户是否已点赞该视频
type: boolean
likeNum:
description: 点赞(收藏)数(真假点赞(收藏)数之和)
type: integer
slug:
description: slug
type: string
tags:
description: 标签
items:
$ref: '#/definitions/proto.TagsInfoData'
type: array
title:
description: 标题
type: string
video:
allOf:
- $ref: '#/definitions/videoinformationmod.VideoInfo'
description: 视频播放信息
watchNum:
description: 观看数(真假观看数之和)
type: integer
type: object
proto.VideoInfo:
properties:
addedTime:
description: 上架时间
type: string
coverImg:
description: 封面
type: string
id:
description: id
type: integer
likeNum:
description: 点赞(收藏)数(真假点赞(收藏)数之和)
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
tags:
description: 标签id
items:
type: integer
type: array
tagsName:
description: 标签名称
items:
type: string
type: array
title:
description: 标题
type: string
watchNum:
description: 观看数(真假观看数之和)
type: integer
type: object
proto.VideoInfoData:
properties:
actressInfo:
description: 女优信息
items:
$ref: '#/definitions/proto.ActressInfoData'
type: array
addedTime:
description: 帖子上架时间
type: string
advitiseId:
description: 广告Id
type: string
bango:
description: 番号,唯一
type: string
collectionInfo:
description: 合集数据
items:
$ref: '#/definitions/proto.VideoInfoData'
type: array
coverImg:
description: 封面
type: string
createInfo:
allOf:
- $ref: '#/definitions/proto.PostCreateInfo'
description: 作者信息
desc:
description: 详细描述
type: string
id:
type: integer
isHot:
description: 是否热门
type: boolean
issuedAt:
description: 发行时间
type: string
issuedBrand:
description: 发行商
type: string
keyworld:
description: 关键字
items:
type: string
type: array
link:
description: 跳转链接
type: string
location:
description: 广告位置id
type: integer
previewVtt:
description: 雪碧图 vtt
type: string
showTimes:
description: 展示次数
type: integer
slug:
description: slug
type: string
tags:
description: 标签
items:
$ref: '#/definitions/proto.TagsInfoData'
type: array
title:
description: 帖子标题
type: string
type:
allOf:
- $ref: '#/definitions/proto.VideoType'
description: 类型
updatedAt:
description: 页面更新时间
type: string
video:
allOf:
- $ref: '#/definitions/videoinformationmod.VideoInfo'
description: Nodes []videoinformationmod.Node `json:"nodes"` //
节点
watchTimes:
description: 观看次数
type: integer
type: object
proto.VideoRankResp:
properties:
bottonTranslations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 底部翻译
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
translations:
allOf:
- $ref: '#/definitions/proto.AppTranslationInfo'
description: 导航
type: object
proto.VideoRecommendItemType:
enum:
- 0
- 2
type: integer
x-enum-comments:
VideoRecommendItemTypeAdvertise: 广告数据
VideoRecommendItemTypeVideo: 视频数据
x-enum-varnames:
- VideoRecommendItemTypeVideo
- VideoRecommendItemTypeAdvertise
proto.VideoRecommendListItem:
properties:
addedTime:
description: 上架时间
type: string
advertiseId:
description: 广告ID,type=2时返回
type: string
coverImg:
description: 封面
type: string
id:
description: id
type: integer
likeNum:
description: 点赞(收藏)数(真假点赞(收藏)数之和)
type: integer
link:
description: 广告跳转链接,type=2时返回
type: string
location:
description: 广告位置ID,type=2时返回
type: integer
seoInfo:
allOf:
- $ref: '#/definitions/pubdef.SeoValue'
description: Seo相关信息
slug:
description: slug
type: string
tags:
description: 标签id
items:
type: integer
type: array
tagsName:
description: 标签名称
items:
type: string
type: array
title:
description: 标题
type: string
type:
allOf:
- $ref: '#/definitions/proto.VideoRecommendItemType'
description: 数据类型 0-视频数据 2-广告
watchNum:
description: 观看数(真假观看数之和)
type: integer
type: object
proto.VideoRecommendListResp:
properties:
list:
description: 当前页数据
pageNum:
description: 当前页码
type: integer
pageSize:
description: 每页数量
type: integer
totalCount:
description: 总数量
type: integer
type: object
proto.VideoType:
enum:
- 0
- 1
- 2
- 3
type: integer
x-enum-comments:
VideoType_AV: AV视频
VideoTypeAdvitise: 广告
VideoTypeCollection: 合集
VideoTypeVideo: 视频
x-enum-varnames:
- VideoTypeVideo
- VideoTypeCollection
- VideoTypeAdvitise
- VideoType_AV
proxy.AdvitiseInfo:
properties:
id:
description: 广告id
type: string
images:
description: 视频banner
type: string
link:
description: 链接
type: string
location:
description: 位置id
type: integer
title:
description: 广告标题
type: string
type: object
pubdef.CommentObjectType:
enum:
- 0
- 4
type: integer
x-enum-comments:
CommentObjectTypePlaylet: 短剧
CommentObjectTypeVideo: 视频
x-enum-varnames:
- CommentObjectTypeVideo
- CommentObjectTypePlaylet
pubdef.DisplayMode:
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
x-enum-comments:
DisplayModeAvatarList: 头像列表
DisplayModeBigCover: 大封面列表(一大图两列)
DisplayModeCardCarousel: 卡片层叠轮播
DisplayModeDefault: 默认(上图下标题多列)
DisplayModeImageText: 图文列表(左图右标题多列)
x-enum-varnames:
- DisplayModeDefault
- DisplayModeCardCarousel
- DisplayModeAvatarList
- DisplayModeImageText
- DisplayModeBigCover
pubdef.LoginType:
enum:
- 0
- 1
- 2
- 3
type: integer
x-enum-comments:
LoginTypeAccount: 账号登陆
LoginTypeDevice: 设备登陆
LoginTypeMobile: 手机登陆
LoginTypeQrCode: 二维码登陆
x-enum-varnames:
- LoginTypeDevice
- LoginTypeMobile
- LoginTypeQrCode
- LoginTypeAccount
pubdef.SeoValue:
properties:
description:
description: 网站SEO描述
type: string
keyworld:
description: 网站SEO关键字
items:
type: string
type: array
title:
description: 网站SEO标题
type: string
type: object
pubdef.TranslationType:
enum:
- 1
- 2
- 3
type: integer
x-enum-comments:
TranslationTypeBottom: 底部导航
TranslationTypeSub: 二级导航
TranslationTypeUrl: URL模式
x-enum-varnames:
- TranslationTypeUrl
- TranslationTypeSub
- TranslationTypeBottom
pubdef.UserStatus:
enum:
- 0
- 1
- 2
type: integer
x-enum-comments:
UserStatusDisable: 封禁
UserStatusNormal: 正常
UserStatusSlient: 禁言
x-enum-varnames:
- UserStatusNormal
- UserStatusDisable
- UserStatusSlient
questionnairemod.Attachment:
properties:
fileType:
description: 附件类型(img / video)
type: string
url:
description: 附件URL地址
type: string
type: object
uploadser.ImageUploadData:
properties:
id:
type: string
sourceNameFs:
type: string
type: object
uploadser.ImageUploadResp:
properties:
code:
type: integer
data:
$ref: '#/definitions/uploadser.ImageUploadData'
hash:
type: boolean
msg:
type: string
time:
type: string
tip:
type: string
type: object
uploadser.VideoBodyData:
properties:
id:
type: string
sourceNameFs:
type: string
taskId:
type: string
type: object
uploadser.VideoBodyResp:
properties:
code:
type: integer
data:
$ref: '#/definitions/uploadser.VideoBodyData'
hash:
type: boolean
msg:
type: string
time:
type: string
tip:
type: string
type: object
uploadser.VideoOkResp:
properties:
code:
type: integer
msg:
type: string
tip:
type: string
type: object
videoinformationmod.VideoInfo:
properties:
cover:
description: 视频封面
type: string
fileId:
description: 媒资库ID
type: string
h265Url:
description: H.265 m3u8 播放地址,空字符串表示暂无该编码源
type: string
height:
description: 分辨率高(视频才会存在)
type: integer
preMp4FileNameFs:
description: 预览MP4文件
type: string
taskId:
description: 视频ID(视频才会存在)
type: string
unencryptedPreMp4:
description: 不加密的预览MP4
type: string
url:
description: H.264 m3u8 播放地址(始终存在)
type: string
videoTime:
description: 影片长度
type: integer
width:
description: 分辨率宽(视频才会存在)
type: integer
type: object
host: 视频站-api.lcncctn.com
info:
contact: {}
description: 这是视频站APP接口服务.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: 视频站APP接口
version: "1.0"
paths:
/api/app/actress/list:
get:
consumes:
- application/json
description: 返回导航、广告和按热度值降序排列的女优列表
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.QueryActressListResp'
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 女优榜单列表 -- by 王鸣
tags:
- 女优相关接口
/api/app/actress/work/list:
get:
consumes:
- application/json
description: 查询指定女优详情和作品列表,支持上架时间/观看量/收藏量升降序,每间隔8条作品数据插入一个广告
parameters:
- description: 上架时间升序/降序(1-升序 2降序)
in: query
name: addedTimeSort
type: integer
- description: 女优ID
in: query
name: id
type: integer
- description: 按收藏(点赞)量升序/降序(1-升序 2降序)
in: query
name: likesSort
type: integer
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
- description: 女优slug,非空时优先按slug解析女优ID
in: query
name: slug
type: string
- description: 按观看量升序/降序(1-升序 2降序)
in: query
name: watchTimesSort
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.QueryActressWorkListResp'
- properties:
list:
items:
allOf:
- $ref: '#/definitions/proto.QueryVideoListItem'
- properties:
VideoInfo:
$ref: '#/definitions/proto.VideoInfo'
type: object
type: array
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 指定女优详情和作品列表 -- by 王鸣
tags:
- 女优相关接口
/api/app/applist/list:
get:
consumes:
- application/json
description: 返回应用分类列表,每个分类下含应用信息列表;categoryId=0 返回第一个分类
parameters:
- description: 当前分类ID,0表示默认第一个分类
in: query
name: categoryId
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.AppListResp'
"400":
description: 失败
schema:
type: string
summary: 查询应用列表
tags:
- 应用列表
/api/app/auth/getInfo:
get:
consumes:
- application/json
description: 根据当前登录 token 查询用户基础信息
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/authser.UserInfoResp'
"400":
description: 失败
schema:
type: string
summary: 获取当前登录用户信息
tags:
- 用户认证
/api/app/auth/login:
post:
consumes:
- application/json
description: 账号均可作为登录凭证
parameters:
- description: 登录参数
in: body
name: param
required: true
schema:
$ref: '#/definitions/authapi.loginReq'
produces:
- application/json
responses:
"200":
description: 登录成功,返回 token 及用户基本信息
schema:
$ref: '#/definitions/authser.LoginResp'
"400":
description: 失败
schema:
type: string
summary: 登录
tags:
- 用户认证
/api/app/auth/profile:
post:
consumes:
- application/json
description: 账号必填;avatar、oldPassword+newPassword 均为可选,至少提供一项。修改密码时旧密码和新密码必须同时提供。
parameters:
- description: 修改资料参数
in: body
name: param
required: true
schema:
$ref: '#/definitions/authapi.updateProfileReq'
produces:
- application/json
responses:
"200":
description: 成功
schema:
type: string
"400":
description: 失败
schema:
type: string
summary: 修改用户资料(头像 / 密码,可任意组合)
tags:
- 用户认证
/api/app/auth/register:
post:
consumes:
- application/json
description: 已登录游客传入账号密码完成升级;未登录用户直接注册新账号。
parameters:
- description: 注册参数
in: body
name: param
required: true
schema:
$ref: '#/definitions/authapi.registerReq'
produces:
- application/json
responses:
"200":
description: 注册成功,返回 token 及用户基本信息
schema:
$ref: '#/definitions/authser.LoginResp'
"400":
description: 失败
schema:
type: string
summary: 注册
tags:
- 用户认证
/api/app/comment/list:
get:
consumes:
- application/json
description: 按对象查询树形评论列表
parameters:
- description: 对象ID
in: query
name: objectId
type: integer
- description: 对象类型 0=视频 4=短剧
enum:
- 0
- 4
in: query
name: objectType
type: integer
x-enum-comments:
CommentObjectTypePlaylet: 短剧
CommentObjectTypeVideo: 视频
x-enum-varnames:
- CommentObjectTypeVideo
- CommentObjectTypePlaylet
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.CommentListResp'
- properties:
list:
items:
$ref: '#/definitions/proto.CommentInfo'
type: array
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 评论列表 -- by 王鸣
tags:
- 评论APP
/api/app/comment/send:
post:
consumes:
- application/json
description: 发布评论
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
$ref: '#/definitions/proto.CommentSendReq'
produces:
- application/json
responses:
"200":
description: 成功
schema:
type: string
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 发布评论 -- by 王鸣
tags:
- 评论APP
/api/app/config/footer/info:
get:
consumes:
- application/json
description: 返回APP底部品牌、底部导航和联系方式
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.FooterInfoResp'
"400":
description: 失败
schema:
type: string
summary: 查询APP底部信息 -- by 王鸣
tags:
- app配置相关接口
/api/app/config/richtext/list:
get:
consumes:
- application/json
description: 返回启用状态的富文本内容,支持按ids或titles过滤
parameters:
- description: 富文本ID,多个用英文逗号分隔
in: query
name: ids
type: string
- description: 富文本标题,多个用英文逗号分隔
in: query
name: titles
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.AppRichTextListResp'
"400":
description: 失败
schema:
type: string
summary: 查询APP富文本内容列表 -- by 王鸣
tags:
- app配置相关接口
/api/app/content/tag/list:
get:
consumes:
- application/json
description: 返回启用且有绑定内容数量的统一标签,contentTagType非必填,按绑定内容数量倒序排序
parameters:
- description: 内容类型 1-视频 5-短剧,不传返回全部有绑定数量的标签
enum:
- 1
- 5
in: query
name: contentTagType
type: integer
x-enum-comments:
ContentTagTypePlaylet: 短剧
ContentTagTypeVideo: 视频
x-enum-varnames:
- ContentTagTypeVideo
- ContentTagTypePlaylet
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.AppContentTagListResp'
"400":
description: 失败
schema:
type: string
summary: 查询APP统一标签列表 -- by 王鸣
tags:
- app配置相关接口
/api/app/home:
get:
consumes:
- application/json
description: 首页分类数据
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.DataResp'
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 首页 --by 旺鸣
tags:
- 首页
/api/app/home/base:
get:
consumes:
- application/json
description: 只返回翻译、配置、底部翻译、广告和公告
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.HomeBaseResp'
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 首页公共数据 --by 旺鸣
tags:
- 首页
/api/app/home/tags:
get:
consumes:
- application/json
description: 返回视频、短剧的标签信息,以及基础导航、配置、广告和公告
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.HomeTagsResp'
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 首页标签数据 --by 旺鸣
tags:
- 首页
/api/app/login/guest:
post:
consumes:
- application/json
description: 按设备 ID 查找已有游客账号,找不到则自动注册。若请求携带有效 token 则优先复用该用户。
parameters:
- description: 设备信息
in: body
name: param
required: true
schema:
$ref: '#/definitions/authapi.guestLoginReq'
produces:
- application/json
responses:
"200":
description: 登录成功
schema:
$ref: '#/definitions/authser.LoginResp'
"400":
description: 失败
schema:
type: string
summary: 游客登录
tags:
- 用户认证
/api/app/navigation/header:
get:
consumes:
- application/json
description: 查询导航类型为URL模式和二级导航的头部导航配置
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.AppTranslationInfo'
"400":
description: 失败
schema:
type: string
summary: 查询头部导航配置 -- by 王鸣
tags:
- app导航相关接口
/api/app/playlet/chapter/info:
get:
consumes:
- application/json
description: 根据剧集ID查询短剧剧集详情、所属短剧、剧集列表、热门短剧列表和点赞状态
parameters:
- description: 剧集ID
in: query
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.QueryPlayletChapterInfoResp'
- properties:
chapterInfo:
$ref: '#/definitions/proto.PlayletChapterInfo'
chapterList:
items:
$ref: '#/definitions/proto.PlayletChapterInfo'
type: array
hotPlayletList:
items:
$ref: '#/definitions/proto.PlayletData'
type: array
playletInfo:
$ref: '#/definitions/proto.PlayletData'
type: object
"400":
description: 失败
schema:
type: string
summary: app端短剧剧集详情 -- by 王鸣
tags:
- app短剧相关接口
/api/app/playlet/info:
get:
consumes:
- application/json
description: 查询短剧详情、剧集列表、热门短剧列表和点赞状态
parameters:
- description: 短剧ID
in: query
name: id
type: integer
- description: 短剧slug,非空时优先按slug解析短剧ID
in: query
name: slug
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.QueryPlayletInfoResp'
- properties:
chapterList:
items:
$ref: '#/definitions/proto.PlayletChapterInfo'
type: array
hotPlayletList:
items:
$ref: '#/definitions/proto.PlayletData'
type: array
playletInfo:
$ref: '#/definitions/proto.PlayletDetailInfo'
type: object
"400":
description: 失败
schema:
type: string
summary: 短剧详情 -- by 王鸣
tags:
- app短剧相关接口
/api/app/playlet/like:
post:
consumes:
- application/json
description: 当前登录用户点赞或取消点赞指定短剧,isLike=true表示点赞,isLike=false表示取消点赞
parameters:
- description: 点赞或取消点赞请求
in: body
name: param
required: true
schema:
$ref: '#/definitions/proto.LikePlayletReq'
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.LikePlayletResp'
"400":
description: 失败
schema:
type: string
security:
- ApiKeyAuth: []
summary: 点赞或取消点赞短剧 -- by 王鸣
tags:
- app短剧相关接口
/api/app/playlet/rank/list:
get:
consumes:
- application/json
description: 分页查询短剧排行榜,rankPeriod=0点赞榜(累计点赞)、1周榜/2月榜/3年榜(周期观看量),独立缓存10分钟,每榜最多50条,pageSize不是50时强制为50
parameters:
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
- description: 榜单类型 0-点赞榜 1-周榜 2-月榜 3-年榜
in: query
name: rankPeriod
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.PlayletRankResp'
- properties:
list:
items:
$ref: '#/definitions/proto.PlayletRankData'
type: array
type: object
"400":
description: 失败
schema:
type: string
summary: 短剧排行榜分页列表 -- by 王鸣
tags:
- app短剧相关接口
/api/app/playlet/recommend/list:
get:
consumes:
- application/json
description: 分页查询短剧列表,带穿插列表广告,每间隔8条短剧数据插入一个广告
parameters:
- description: 短剧分类ID,不传查询全部分类
in: query
name: categoryId
type: integer
- description: 分类slug,非空时优先按slug解析分类ID
in: query
name: categorySlug
type: string
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
- description: 排序方式 1-推荐 2-最新 3-最热
in: query
name: sortList
type: integer
- description: 标签ID,不传查询全部标签
in: query
name: tagId
type: integer
- description: 标签slug,非空时优先按slug解析标签ID
in: query
name: tagSlug
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.PlayletRecommendListResp'
- properties:
list:
items:
$ref: '#/definitions/proto.PlayletRecommendListItem'
type: array
type: object
"400":
description: 失败
schema:
type: string
summary: app端推荐短剧列表 -- by 王鸣
tags:
- app短剧相关接口
/api/app/playlet/tag/{id}:
get:
consumes:
- application/json
description: 根据统一标签ID分页查询短剧列表,带穿插列表广告,每间隔8条短剧数据插入一个广告
parameters:
- description: 标签ID
in: path
name: id
required: true
type: integer
- description: 页码,默认1
in: query
name: pageNum
type: integer
- description: 每页数量,默认20,最大100
in: query
name: pageSize
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.PlayletRecommendListResp'
- properties:
list:
items:
$ref: '#/definitions/proto.PlayletRecommendListItem'
type: array
type: object
"400":
description: 失败
schema:
type: string
summary: app端根据标签ID查询短剧列表 -- by 王鸣
tags:
- app短剧相关接口
/api/app/questionnaire/submit:
post:
consumes:
- application/json
description: 用户提交问题反馈问卷
parameters:
- description: 提交参数
in: body
name: param
required: true
schema:
$ref: '#/definitions/proto.QuestionnaireSubmitReq'
produces:
- application/json
responses:
"200":
description: 成功
schema:
type: string
"400":
description: 失败
schema:
type: string
summary: 提交问卷
tags:
- 问卷调查APP
/api/app/richtext:
get:
description: 从缓存中查询启用状态的富文本信息
parameters:
- description: 富文本内部标题
in: query
name: title
required: true
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.RichTextInfo'
"400":
description: 失败
schema:
type: string
summary: 按 title 查询富文本
tags:
- 富文本
/api/app/upload/image:
post:
consumes:
- multipart/form-data
description: 将图片转发至存储服务 /media/web/autopublish/image
parameters:
- description: 图片文件
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/uploadser.ImageUploadResp'
"400":
description: 参数错误
schema:
type: string
summary: 图片上传
tags:
- 上传
/api/app/upload/videoBody:
post:
consumes:
- multipart/form-data
description: 将视频分片转发至存储服务 /media/web/autopublish/videoBody
parameters:
- description: 视频任务ID
in: formData
name: taskId
required: true
type: string
- description: 当前分片序号,从0开始
in: formData
name: pos
required: true
type: string
- description: 上传用户名,为空默认 questionnaires
in: formData
name: uploadUserName
type: string
- description: 分片文件数据
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/uploadser.VideoBodyResp'
"400":
description: 参数错误
schema:
type: string
summary: 视频分片上传
tags:
- 上传
/api/app/upload/videoOk:
post:
consumes:
- application/json
description: 所有分片上传完毕后调用,转发至存储服务 /media/web/autopublish/videoOk
parameters:
- description: '{ \'
in: body
name: param
required: true
schema:
type: object
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/uploadser.VideoOkResp'
"400":
description: 参数错误
schema:
type: string
summary: 视频分片上传完成通知
tags:
- 上传
/api/app/video/favorite:
post:
consumes:
- application/json
description: 当前登录用户收藏或取消收藏指定视频,isFavorite=true表示收藏,isFavorite=false表示取消收藏
parameters:
- description: 收藏或取消收藏请求
in: body
name: param
required: true
schema:
$ref: '#/definitions/proto.FavoriteVideoReq'
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.FavoriteVideoResp'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 收藏或取消收藏视频 --by 旺鸣
tags:
- 视频相关接口
/api/app/video/favorite/list:
get:
consumes:
- application/json
description: 当前登录用户收藏视频分页列表,按收藏时间倒序排序
parameters:
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.QueryFavoriteVideoListResp'
- properties:
list:
items:
$ref: '#/definitions/proto.FavoriteVideoListItem'
type: array
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 当前登录用户收藏视频分页列表 --by 旺鸣
tags:
- 视频相关接口
/api/app/video/info:
get:
consumes:
- application/json
description: 查询视频详情、热门视频列表、收藏状态和点赞状态
parameters:
- in: query
name: id
type: integer
- description: 视频slug,非空时优先按slug解析视频ID
in: query
name: slug
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.QueryVideoInfoResp'
- properties:
hotVideoList:
items:
$ref: '#/definitions/proto.VideoData'
type: array
videoInfo:
$ref: '#/definitions/proto.VideoDetailInfo'
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 视频详情 -- by 王鸣
tags:
- 视频相关接口
/api/app/video/like:
post:
consumes:
- application/json
description: 当前登录用户点赞或取消点赞指定视频,isLike=true表示点赞,isLike=false表示取消点赞
parameters:
- description: 点赞或取消点赞请求
in: body
name: param
required: true
schema:
$ref: '#/definitions/proto.LikeVideoReq'
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.LikeVideoResp'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 点赞或取消点赞视频 -- by 王鸣
tags:
- 视频相关接口
/api/app/video/more:
get:
consumes:
- application/json
description: 根据分类id查询视频列表,带穿插列表广告,每间隔8条视频数据插入一个广告
parameters:
- description: 视频分类id
in: query
name: categoryId
type: integer
- description: 分类slug,非空时优先按slug解析分类ID
in: query
name: categorySlug
type: string
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.QueryVideoResp'
- properties:
list:
items:
allOf:
- $ref: '#/definitions/proto.QueryVideoListItem'
- properties:
VideoInfo:
$ref: '#/definitions/proto.VideoInfo'
type: object
type: array
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 根据分类id查询视频列表 --by 王鸣
tags:
- 视频相关接口
/api/app/video/rank:
get:
consumes:
- application/json
description: 视频收藏排行榜
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.RankResp'
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 视频收藏排行榜
tags:
- 视频相关接口
/api/app/video/rank/list:
get:
consumes:
- application/json
description: 分页查询视频排行榜,rankPeriod=0点赞榜(累计点赞)、1周榜/2月榜/3年榜(周期观看量),独立缓存10分钟,每榜最多50条,pageSize不是50时强制为50
parameters:
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
- description: 榜单类型 0-点赞榜 1-周榜 2-月榜 3-年榜
in: query
name: rankPeriod
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.VideoRankResp'
- properties:
list:
items:
$ref: '#/definitions/proto.ContentData'
type: array
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
summary: 视频排行榜分页列表 -- by 王鸣
tags:
- 视频相关接口
/api/app/video/recommend/list:
get:
consumes:
- application/json
description: 分页查询视频列表,带穿插列表广告,每间隔8条视频数据插入一个广告
parameters:
- description: 分类id,不传查询全部分类id
in: query
name: categoryId
type: integer
- description: 分类slug,非空时优先按slug解析分类ID
in: query
name: categorySlug
type: string
- in: query
name: pageNum
type: integer
- in: query
name: pageSize
type: integer
- description: 排序方式 1-推荐 2-最新 3-最热
in: query
name: sortList
type: integer
- description: 标签ID,不传查询全部标签
in: query
name: tagId
type: integer
- description: 标签slug,非空时优先按slug解析标签ID
in: query
name: tagSlug
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.VideoRecommendListResp'
- properties:
list:
items:
$ref: '#/definitions/proto.VideoRecommendListItem'
type: array
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
summary: app端推荐视频列表 -- by 王鸣
tags:
- 视频相关接口
/api/app/video/tag/{id}:
get:
consumes:
- application/json
description: 根据统一标签ID分页查询视频列表,带穿插列表广告,每间隔8条视频数据插入一个广告
parameters:
- description: 标签ID
in: path
name: id
required: true
type: integer
- description: 页码,默认1
in: query
name: pageNum
type: integer
- description: 每页数量,默认20,最大100
in: query
name: pageSize
type: integer
produces:
- application/json
responses:
"200":
description: 成功
schema:
allOf:
- $ref: '#/definitions/proto.VideoRecommendListResp'
- properties:
list:
items:
$ref: '#/definitions/proto.VideoRecommendListItem'
type: array
type: object
"400":
description: 获取失败的返回结果
schema:
type: string
summary: app端根据标签ID查询视频列表 -- by 王鸣
tags:
- 视频相关接口
/businessCooperation:
get:
consumes:
- application/json
description: 导航
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.HomeHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 导航
tags:
- 导航
/consulting:
get:
consumes:
- application/json
description: 招募
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.HomeHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 招募
tags:
- 招募
/consultinginfo/:id:
get:
consumes:
- application/json
description: 招募详情
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.HomeHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 招募详情
tags:
- 招募详情
/dh:
get:
consumes:
- application/json
description: 导航
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.DHHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 导航
tags:
- 导航
/dmca:
get:
consumes:
- application/json
description: dmca
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.LawAndTrustHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: dmca
tags:
- dmca
/privacyPolicy:
get:
consumes:
- application/json
description: 隐私策略
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.LawAndTrustHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 隐私策略
tags:
- 隐私策略
/search:
get:
consumes:
- application/json
description: '搜索,支持查询参数:title=关键词&page=1&type=0&sort=default(不传type=全部;type:
0=视频 1=女优 3=AV 6=短剧;sort: default/hot/new)'
parameters:
- description: 搜索关键词
in: query
name: title
type: string
- description: 页码,默认1
in: query
name: page
type: integer
- description: 媒体类型,不传=全部,0=视频 1=女优 3=AV 6=短剧
in: query
name: type
type: integer
- description: 排序方式 default/hot/new,默认default
in: query
name: sort
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.SearchResp'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 搜索
tags:
- 搜索
/servicesProject:
get:
consumes:
- application/json
description: 导航
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.HomeHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 导航
tags:
- 导航
/statement:
get:
consumes:
- application/json
description: 合规声明
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.LawAndTrustHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 合规声明
tags:
- 合规声明
/useragreement:
get:
consumes:
- application/json
description: 用户协议
parameters:
- description: 参数列表
in: body
name: param
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: 成功
schema:
$ref: '#/definitions/proto.LawAndTrustHtmlData'
"400":
description: 获取失败的返回结果
schema:
type: string
security:
- ApiKeyAuth: []
summary: 用户协议
tags:
- 用户协议
schemes:
- http
- https
securityDefinitions:
ApiKeyAuth:
in: header
name: Authorization
type: apiKey
BasicAuth:
type: basic
OAuth2AccessCode:
authorizationUrl: https://example.com/oauth/authorize
flow: accessCode
scopes:
admin: Grants read and write access to administrative information
tokenUrl: https://example.com/oauth/token
type: oauth2
OAuth2Application:
flow: application
scopes:
admin: Grants read and write access to administrative information
write: Grants write access
tokenUrl: https://example.com/oauth/token
type: oauth2
OAuth2Implicit:
authorizationUrl: https://example.com/oauth/authorize
flow: implicit
scopes:
admin: Grants read and write access to administrative information
write: Grants write access
type: oauth2
OAuth2Password:
flow: password
scopes:
admin: Grants read and write access to administrative information
read: Grants read access
write: Grants write access
tokenUrl: https://example.com/oauth/token
type: oauth2
swagger: "2.0"