basePath: / definitions: authapi.updateProfileReq: properties: avatar: description: 新头像 URL（可选） type: string introduction: description: 简介（可选） type: string nickName: description: 新昵称（可选） type: string privacyMode: description: 隐私模式：true-开启，false-关闭（可选） type: boolean type: object authser.LoginResp: properties: accountNo: type: string avatar: description: 头像 type: string currentVipExpire: description: VIP 过期时间，客户端需结合 vipType 判断是否真正有效 type: string email: type: string introduction: description: 简介 type: string inviteCode: description: 邀请码 type: string isRegister: description: 是否已注册 type: boolean loginType: allOf: - $ref: '#/definitions/pubdef.LoginType' description: 登陆方式 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' type: allOf: - $ref: '#/definitions/pubdef.UserType' description: 身份类型：0游客 1普通用户 userId: type: integer vipType: $ref: '#/definitions/pubdef.VipType' type: object coinapi.buyCoinReq: properties: packageId: description: 购买套餐ID（金币充值） type: integer payMode: description: 支付方式：alipay/wechat type: string required: - packageId - payMode type: object coinser.BuyCoinResp: properties: isOpenNewBrowser: type: boolean payUrl: type: string payUrlMode: type: string tradeNo: type: string type: object cointransmod.FlowDir: enum: - 1 - -1 type: integer x-enum-comments: FlowIn: 收入（充值、赠送） FlowOut: 支出（消费、解锁） x-enum-varnames: - FlowIn - FlowOut cointransmod.TranType: enum: - 1 - 2 - 3 - 4 - 5 type: integer x-enum-comments: TranTypeAdminAdjust: 管理员手动调整 TranTypeCoinRecharge: 金币充值（购买金币） TranTypeDarkAlley: 历史遗留交易类型（已下线） TranTypeVideoUnlock: 视频解锁 TranTypeVipGiftCoin: 购买会员赠送金币 x-enum-varnames: - TranTypeCoinRecharge - TranTypeVipGiftCoin - TranTypeDarkAlley - TranTypeVideoUnlock - TranTypeAdminAdjust proto.AnnouncementItem: properties: content: description: 内容 type: string id: description: 公告ID type: integer title: description: 标题 type: string 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.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/proxy.AdvitiseData' 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 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.CoinTransListItemResp: 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: allOf: - $ref: '#/definitions/cointransmod.FlowDir' description: 收支方向：1-收入，-1-支出 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: allOf: - $ref: '#/definitions/cointransmod.TranType' description: 交易类型 1-金币充值（购买金币）2-购买会员赠送金币 3-历史遗留 4-视频解锁 5-管理员手动调整 tranTypeName: description: 交易类型名称 type: string type: object proto.CommentInfo: properties: children: description: 二级评论列表 items: $ref: '#/definitions/proto.CommentInfo' type: array 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 type: object proto.CommentLikeSetReq: properties: commentId: description: 评论ID type: integer isLike: description: 是否点赞，true-点赞，false-取消点赞 type: boolean required: - commentId - isLike type: object proto.CommentLikeSetResp: properties: commentId: description: 评论ID type: integer countLike: description: 评论点赞数 type: integer isLike: description: 点赞状态 1-已点赞 2-未点赞 type: integer type: object proto.CommentSendReq: 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 type: object proto.CommonData: properties: anchor: description: 作者/演员 type: string banner: description: banner图，已拼接图片域名 type: string 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 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 playName: description: 剧名 type: string seoInfo: allOf: - $ref: '#/definitions/pubdef.SeoValue' description: Seo相关信息 showOnBanner: description: 是否显示在首页banner type: boolean slug: description: slug type: string status: description: '状态: 0下架 1上架' type: integer tagIds: description: 标签ID集合 items: type: integer type: array tagNames: description: 标签名称集合 items: type: string type: array tagSlugs: description: 标签slug集合 items: type: string type: array themeIds: description: 题材ID集合 items: type: integer type: array themeNames: description: 题材名称集合 items: type: string type: array themeSlugs: description: 题材slug集合 items: type: string type: array title: description: 标题 type: string totalEpisode: description: 总集数 type: integer updateStatus: description: 更新状态 1-连载中 2-已完结 type: integer updatedAt: description: 修改时间 type: string type: object proto.ConfigInfo: 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关键字 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 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 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 watermarkImage: description: 图片水印文件 type: string 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.ConfigInfoResp: properties: advitise: allOf: - $ref: '#/definitions/proxy.AdvitiseData' description: 广告配置 config: allOf: - $ref: '#/definitions/proto.ConfigInfo' description: 完整系统配置（与首页等接口的 config 一致，含 potaoGroup 等其余字段） navPageList: description: 导航页线路集合 items: $ref: '#/definitions/proto.NavPageItem' type: array newAddressInfo: allOf: - $ref: '#/definitions/proto.NewAddressInfo' description: 最新地址信息 seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 全站SEO信息 seoNavInfo: allOf: - $ref: '#/definitions/proto.SeoNavInfo' description: 导航SEO信息 type: object proto.ContactUsAddReq: properties: attachments: description: 附件地址，可存放多张图片或文件地址 items: type: string type: array content: description: 内容 type: string email: description: 邮箱 type: string title: description: 标题 type: string type: description: 问题类型，1-订单问题、2-账号问题、3-功能问题、4-体验问题、5-其他 type: integer required: - content - email - title - type type: object proto.ContactUsAddResp: properties: message: description: 提示信息 type: string type: object proto.FeedbackReq: properties: contact: description: 联系方式，可为空 type: string content: description: 描述内容，最多500字 type: string screenshots: description: 问题截图，可存放多张图片地址 items: type: string type: array type: description: 问题类型，1-功能建议、2-Bug反馈、3-体验问题、4-账号问题、5-其他 type: integer required: - content - type type: object proto.FeedbackResp: properties: message: description: 提示信息 type: string 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.GetCommentListResp: properties: list: description: 数据 items: $ref: '#/definitions/proto.CommentInfo' type: array objectId: description: 对象ID type: integer pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总数量 type: integer type: object proto.HomeBannerData: 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.HomeCategoryData: properties: desc: description: 描述 type: string icon: description: 分类图标 type: string id: description: 分类ID type: integer list: description: 分类下短剧集合，最多16条 items: $ref: '#/definitions/proto.CommonData' type: array name: description: 分类名称 type: string rank: description: 分类排序，越大越靠前 type: integer slug: description: slug type: string type: object proto.HomeHtmlData: properties: advitise: allOf: - $ref: '#/definitions/proxy.AdvitiseData' 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.HomePlayletResponse: properties: announcements: description: 启用中的公告，来自独立缓存 items: $ref: '#/definitions/proto.AnnouncementItem' type: array homeBannerData: description: 首页banner信息列表 items: $ref: '#/definitions/proto.HomeBannerData' type: array homeCategoryData: description: 启用分类短剧集合，按分类排序，每个分类最多16条 items: $ref: '#/definitions/proto.HomeCategoryData' type: array homeRecommendThemes: description: 推荐主题，最多4条 items: $ref: '#/definitions/proto.HomeRecommendTheme' type: array homeTodayUpdateData: description: 最近更新集合，最多16条 items: $ref: '#/definitions/proto.CommonData' type: array seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息（短剧列表页SEO） type: object proto.HomeRecommendTheme: properties: icon: description: 题材图标，已拼接图片域名 type: string id: description: 题材ID type: integer name: description: 题材名称 type: string playletCount: description: 该题材绑定的上架短剧数量 type: integer rank: description: 排序，越大越靠前 type: integer slug: description: slug type: string type: object proto.HotSearchItem: 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 type: object proto.NavPageItem: properties: line: description: 线路序号 type: integer url: description: 线路地址 type: string type: object proto.NewAddressInfo: 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 type: object proto.PayMethodInfo: properties: type: description: alipay / wechat / union type: string typeName: description: 支付宝 / 微信 / 银联 type: string type: object proto.PlayletChapterCollectData: 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 type: object proto.PlayletChapterCollectListResp: properties: list: description: 收藏剧集集合 items: $ref: '#/definitions/proto.PlayletChapterCollectData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总收藏数量 type: integer type: object proto.PlayletChapterCollectSetReq: properties: chapterId: description: 短剧剧集ID type: integer isCollect: description: 是否收藏，true-收藏，false-取消收藏 type: boolean required: - chapterId - isCollect type: object proto.PlayletChapterCollectSetResp: properties: chapterId: description: 短剧剧集ID type: integer countCollect: description: 短剧剧集收藏数 type: integer isCollect: description: 收藏状态 1-已收藏 2-未收藏 type: integer type: object proto.PlayletChapterData: 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 type: object proto.PlayletChapterInfoResp: 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: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息 singleCoins: description: 单集金币（支付方式为1-金币时候生效） type: integer title: description: 章节名 type: string videoUrl: description: 视频地址 type: string vipValid: description: 当前用户VIP是否有效 type: boolean width: description: 宽 type: integer type: object proto.PlayletChapterLikeSetReq: properties: chapterId: description: 短剧剧集ID type: integer isLike: description: 是否点赞，true-点赞，false-取消点赞 type: boolean required: - chapterId - isLike type: object proto.PlayletChapterLikeSetResp: properties: chapterId: description: 短剧剧集ID type: integer countLike: description: 短剧剧集点赞数 type: integer isLike: description: 点赞状态 1-已点赞 2-未点赞 type: integer type: object proto.PlayletChapterListResp: properties: list: description: 短剧剧集集合 items: $ref: '#/definitions/proto.PlayletChapterData' type: array playletId: description: 短剧ID type: integer type: object proto.PlayletChapterUnlockReq: properties: chapterId: description: 短剧剧集ID type: integer playletId: description: 短剧ID type: integer required: - chapterId - playletId type: object proto.PlayletChapterUnlockResp: 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 type: object proto.PlayletChapterWatchReportReq: properties: chapterId: description: 短剧剧集ID type: integer playletId: description: 短剧ID，传入时用于校验剧集归属 type: integer required: - chapterId type: object proto.PlayletChapterWatchReportResp: 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 type: object proto.PlayletCollectData: 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 playName: description: 剧名 type: string seoInfo: allOf: - $ref: '#/definitions/pubdef.SeoValue' description: Seo相关信息 slug: description: slug type: string tagIds: description: 标签ID集合 items: type: integer type: array tagNames: description: 标签名称集合 items: type: string type: array tagSlugs: description: 标签slug集合 items: type: string type: array themeIds: description: 题材ID集合 items: type: integer type: array themeNames: description: 题材名称集合 items: type: string type: array themeSlugs: description: 题材slug集合 items: type: string type: array title: description: 标题 type: string totalEpisode: description: 总集数 type: integer unwatchedCount: description: 当前用户未看集数，按totalEpisode-watchedCount计算 type: integer updateStatus: description: 更新状态 1-连载中 2-已完结 type: integer watchedCount: description: 当前用户已看集数 type: integer type: object proto.PlayletCollectListResp: properties: list: description: 收藏短剧集合 items: $ref: '#/definitions/proto.PlayletCollectData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总收藏数量 type: integer type: object proto.PlayletCollectSetReq: properties: id: description: 短剧ID type: integer isCollect: description: 是否收藏，true-收藏，false-取消收藏 type: boolean required: - id - isCollect type: object proto.PlayletCollectSetResp: properties: countCollect: description: 短剧收藏数 type: integer id: description: 短剧ID type: integer isCollect: description: 收藏状态 1-已收藏 2-未收藏 type: integer type: object proto.PlayletForwardHeatReq: properties: id: description: 短剧ID type: integer required: - id type: object proto.PlayletForwardHeatResp: properties: heatValue: description: 加热后的热度值 type: integer id: description: 短剧ID type: integer type: object proto.PlayletHistoryClearResp: properties: deletedCount: description: 删除记录数量 type: integer type: object proto.PlayletHistoryData: properties: anchor: description: 作者/演员 type: string banner: description: banner图，已拼接图片域名 type: string 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 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 playName: description: 剧名 type: string seoInfo: allOf: - $ref: '#/definitions/pubdef.SeoValue' description: Seo相关信息 showOnBanner: description: 是否显示在首页banner type: boolean slug: description: slug type: string status: description: '状态: 0下架 1上架' type: integer tagIds: description: 标签ID集合 items: type: integer type: array tagNames: description: 标签名称集合 items: type: string type: array tagSlugs: description: 标签slug集合 items: type: string type: array themeIds: description: 题材ID集合 items: type: integer type: array themeNames: description: 题材名称集合 items: type: string type: array themeSlugs: description: 题材slug集合 items: type: string type: array 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 type: object proto.PlayletHistoryListResp: properties: list: description: 观看历史集合 items: $ref: '#/definitions/proto.PlayletHistoryData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总历史数量 type: integer type: object proto.PlayletHotLikeResp: properties: guessLike: description: 按收藏量最多的15部上架短剧 items: $ref: '#/definitions/proto.CommonData' type: array hotSearch: description: 前10个热搜词 items: $ref: '#/definitions/proto.PlayletHotSearchItem' type: array type: object proto.PlayletHotSearchItem: properties: count: description: 搜索次数 type: integer keyword: description: 搜索词 type: string type: object proto.PlayletInfoResp: properties: anchor: description: 作者/演员 type: string banner: description: banner图，已拼接图片域名 type: string 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 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 playName: description: 剧名 type: string playletChapterInfo: description: 短剧章节集合 items: $ref: '#/definitions/proto.PlayletChapterData' type: array relatedRecommendData: description: 相关推荐集合 items: $ref: '#/definitions/proto.CommonData' type: array seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息 showOnBanner: description: 是否显示在首页banner type: boolean slug: description: slug type: string status: description: '状态: 0下架 1上架' type: integer tagIds: description: 标签ID集合 items: type: integer type: array tagNames: description: 标签名称集合 items: type: string type: array tagSlugs: description: 标签slug集合 items: type: string type: array themeIds: description: 题材ID集合 items: type: integer type: array themeNames: description: 题材名称集合 items: type: string type: array themeSlugs: description: 题材slug集合 items: type: string type: array title: description: 标题 type: string totalEpisode: description: 总集数 type: integer updateStatus: description: 更新状态 1-连载中 2-已完结 type: integer updatedAt: description: 修改时间 type: string type: object proto.PlayletLikeSetReq: properties: id: description: 短剧ID type: integer isLike: description: 是否点赞，true-点赞，false-取消点赞 type: boolean required: - id - isLike type: object proto.PlayletLikeSetResp: properties: countLike: description: 短剧点赞数 type: integer id: description: 短剧ID type: integer isLike: description: 点赞状态 1-已点赞 2-未点赞 type: integer type: object proto.PlayletOperateListResp: properties: filterType: description: 筛选类型 1-最近更新 2-当前热播 3-独家原创 type: integer list: description: 短剧集合 items: $ref: '#/definitions/proto.CommonData' type: array operateType: description: 运营类型 1-短剧 2-漫剧 type: integer pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总共数量 type: integer type: object proto.PlayletRankResp: properties: list: description: 短剧集合 items: $ref: '#/definitions/proto.CommonData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息（短剧列表页SEO） totalCount: description: 总共数量 type: integer type: object proto.PlayletRecommendListResp: properties: categoryDesc: description: 分类描述 type: string categoryId: description: 分类ID type: integer categoryName: description: 分类名称 type: string categorySlug: description: 分类slug type: string list: description: 短剧集合 items: $ref: '#/definitions/proto.CommonData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息（分类SEO） totalCount: description: 总共数量 type: integer type: object proto.PlayletSearchResp: properties: list: description: 短剧集合 items: $ref: '#/definitions/proto.CommonData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总共数量 type: integer type: object proto.PlayletTagVideoResp: properties: list: description: 短剧集合 items: $ref: '#/definitions/proto.CommonData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息（标签SEO） totalCount: description: 总共数量 type: integer type: object proto.PlayletThemeItem: 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: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 题材对应页面 SEO 信息 slug: description: slug type: string status: description: 上架状态 type: boolean type: object proto.PlayletThemeListResponse: properties: list: description: 题材列表 items: $ref: '#/definitions/proto.PlayletThemeItem' type: array type: object proto.PlayletTodayUpdateResp: properties: list: description: 短剧集合 items: $ref: '#/definitions/proto.CommonData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息（短剧列表页SEO） totalCount: description: 总共数量 type: integer type: object proto.PlayletVideoResp: properties: list: description: 短剧集合 items: $ref: '#/definitions/proto.CommonData' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息：有 themeId 时返回题材 SEO，否则返回短剧列表页 SEO totalCount: description: 总共数量 type: integer type: object proto.RechargePackageItem: 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: allOf: - $ref: '#/definitions/rechargepackagemod.PackageType' description: 套餐类型：1-会员畅享 2-金币充值 payMethods: description: 该套餐支持的支付方式 items: $ref: '#/definitions/proto.PayMethodInfo' type: array price: description: 售价，单位分 type: integer sort: description: 排序，越小越靠前 type: integer subTitle: description: 展示副标题 type: string totalCoin: description: 到账总金币数，由baseCoin+giftCoin计算 type: integer type: object proto.RechargePackageListResp: properties: coinList: description: 金币充值列表 items: $ref: '#/definitions/proto.RechargePackageItem' type: array vipList: description: 会员畅享列表 items: $ref: '#/definitions/proto.RechargePackageItem' type: array type: object proto.SeoInfo: properties: canonicalUrl: description: 当前内容的标准URL type: string description: description: 页面描述 type: string keywords: description: 页面关键词 items: type: string type: array title: description: 页面标题 type: string webSiteName: description: 网站名称 type: string type: object proto.SeoNavInfo: properties: dhDescription: description: 导航描述 type: string dhKeyworld: description: 关键词 items: type: string type: array dhSiteName: description: 导航名称 type: string dhTitle: description: 导航标题 type: string type: object proto.TranslationCategory: properties: categoryType: allOf: - $ref: '#/definitions/pubdef.TranslationType' description: 导航类型 icon: description: Icon type: string id: type: integer name: description: 名称 type: string seoInfo: allOf: - $ref: '#/definitions/pubdef.SeoValue' description: Seo相关信息 translationList: items: $ref: '#/definitions/proto.TranslationInfo' type: array urlValue: description: URl路径 type: string type: object proto.TranslationInfo: properties: isFriendAds: description: 是否是友链广告位 type: boolean name: description: 名称 type: string urlValue: description: URl路径 type: string type: object proto.VideoData: properties: cover: description: 视频封面 type: string fileId: description: 媒资库ID type: string height: description: 分辨率高（视频才会存在） type: integer preMp4FileNameFs: description: 预览MP4文件 type: string taskId: description: 视频ID（视频才会存在） type: string unencryptedPreMp4: description: 不加密的预览MP4 type: string url: description: 视频URl type: string videoTime: description: 影片长度 type: integer width: description: 分辨率宽（视频才会存在） type: integer type: object proto.VideoInfoResp: properties: advitise: allOf: - $ref: '#/definitions/proxy.AdvitiseData' description: 广告 coverImg: description: 封面 type: string id: description: id type: integer keyworld: description: 关键字 items: type: string type: array recommendVideos: description: 相关推荐，按当前视频标签匹配并按上架时间倒序返回最多20条 items: $ref: '#/definitions/proto.VideoItemResp' type: array seoInfo: allOf: - $ref: '#/definitions/proto.SeoInfo' description: 页面SEO信息 tags: description: 标签 items: type: integer type: array tagsName: description: 标签名称 items: type: string type: array title: description: 标题 type: string video: allOf: - $ref: '#/definitions/proto.VideoData' description: 视频 watchTimes: description: 观看数（真假之和） type: integer type: object proto.VideoItemResp: properties: addedTime: description: 上架时间 type: string coverImg: description: 封面 type: string creatorId: description: 作者Id type: integer creatorName: description: 作者名称 type: string id: description: id type: integer keyworld: description: 关键字 items: type: string type: array tags: description: 标签 items: type: integer type: array title: description: 标题 type: string videoTime: description: 影片长度 type: integer watchTimes: description: 观看数（真假之和） type: integer type: object proto.VideoResp: properties: list: description: 视频列表 items: $ref: '#/definitions/proto.VideoItemResp' type: array pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总共数量 type: integer type: object proxy.AdvitiseData: properties: appInfoAList: description: 应用管理广告A items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array appInfoBList: description: 应用管理广告B items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array dialogList: description: 弹窗广告 items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array forcedJumpList: 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 hotAppList: description: 热门应用 items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array mustAppList: description: 必备精品 items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array newAppList: description: 最新上架 items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array nineGridList: description: 9宫格 items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array stopList: description: 暂停广告 items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array titleAppList: description: 标题广告（APP名称） items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array videoDownList: description: 帖子详情（下） items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array videoList: description: 视频列表 items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array videoTopList: description: 帖子详情（上） items: $ref: '#/definitions/proxy.AdvitiseInfo' type: array type: object 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.LoginType: enum: - 0 - 1 - 2 type: integer x-enum-comments: LoginTypeAccount: 账号登陆 LoginTypeDevice: 设备登陆 LoginTypeEmail: 邮箱登陆 x-enum-varnames: - LoginTypeDevice - LoginTypeAccount - LoginTypeEmail 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 pubdef.UserType: enum: - 0 - 1 - 0 type: integer x-enum-comments: UserTypeGuest: 游客用户 UserTypeNormal: 普通用户（已注册） x-enum-varnames: - UserTypeGuest - UserTypeNormal - UserTypeNone pubdef.VipOrderStatus: enum: - 1 - 2 - 3 type: integer x-enum-comments: VipOrderFailed: 支付失败 VipOrderPending: 待支付 VipOrderSuccess: 支付成功 x-enum-varnames: - VipOrderPending - VipOrderSuccess - VipOrderFailed pubdef.VipType: enum: - 0 - 1 - 2 type: integer x-enum-comments: VipTypeMonth: 月卡 VipTypeNone: 没卡 VipTypeYear: 年卡 x-enum-varnames: - VipTypeNone - VipTypeMonth - VipTypeYear rechargeapi.submitOrderReq: properties: packageId: description: 购买套餐ID（会员畅享） type: integer payMode: description: 支付方式：alipay/wechat type: string required: - packageId - payMode type: object rechargepackagemod.PackageType: enum: - 1 - 2 type: integer x-enum-comments: PackageTypeCoin: 金币充值 PackageTypeVip: 会员畅享 x-enum-varnames: - PackageTypeVip - PackageTypeCoin rechargeser.SubmitOrderResp: properties: isOpenNewBrowser: description: 是否需要外部浏览器打开 type: boolean payUrl: description: 支付链接 type: string payUrlMode: description: 链接打开方式 type: string tradeNo: description: 本地订单号（可用于查询） type: string type: object response.BasePageResp: properties: list: description: 集合列表 pageNum: description: 页数 type: integer pageSize: description: 每页数 type: integer totalCount: description: 总共数量 type: integer type: object statcenter.AiSellMsg: 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 type: object statcenter.BuyVIPType: enum: - 0 - 1 type: integer x-enum-comments: BuyVIPTypeGold: 金币 BuyVIPTypeMoney: 现金 x-enum-varnames: - BuyVIPTypeMoney - BuyVIPTypeGold statcenter.CardSellMsg: 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 type: object statcenter.ConsumeRecordMsg: 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 type: object statcenter.Product: properties: discountedPrice: type: integer id: type: string name: type: string type: object statcenter.StatcenterSyncReq: properties: job: description: 同步任务类型 type: string maxSize: description: 最大条数 type: integer platformId: description: 原始平台Id(访问/流水) type: string successTime: description: 游标时间(购买会员、提现、充值) type: string userId: description: 用户(注册) type: integer type: object statcenter.StatcenterSyncResp: properties: accessList: description: 日活记录 items: $ref: '#/definitions/statcenter.UserVisitMsg' type: array aiSellList: description: AI销售流水 items: $ref: '#/definitions/statcenter.AiSellMsg' type: array allRechargeList: description: 全部支付订单 items: $ref: '#/definitions/statcenter.UserRechargeMsg' type: array bindingList: description: 用户绑定记录 items: $ref: '#/definitions/statcenter.UserBindingMsg' type: array buyVipList: description: VIP购买记录 items: $ref: '#/definitions/statcenter.UserBuyVIPMsg' type: array cardSellList: description: 会员卡销售流水 items: $ref: '#/definitions/statcenter.CardSellMsg' type: array code: description: 200正常 其他异常 type: integer consumeList: description: 消费流水 items: $ref: '#/definitions/statcenter.ConsumeRecordMsg' type: array inviteList: description: 邀请绑定 items: $ref: '#/definitions/statcenter.UserInviteBindMsg' type: array job: description: 类型 type: string msg: description: 错误消息 type: string rechargeList: description: 充值记录 items: $ref: '#/definitions/statcenter.UserRechargeMsg' type: array registerList: description: 注册记录 items: $ref: '#/definitions/statcenter.UserRegisterMsg' type: array visitList: description: 日活记录（旧字段，兼容） items: $ref: '#/definitions/statcenter.UserVisitMsg' type: array type: object statcenter.UserBindingMsg: 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 type: object statcenter.UserBuyVIPMsg: 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 type: object statcenter.UserInviteBindMsg: properties: appId: type: integer inviteTime: type: string parentPromCode: type: string userId: type: integer required: - appId - inviteTime - userId type: object statcenter.UserRechargeMsg: 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 required: - appId - money - orderId - payMoney - sysType - userId type: object statcenter.UserRegisterMsg: 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 required: - appId - isDirect - registerTime - sysType - userId type: object statcenter.UserVisitMsg: 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 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 vipordermod.OrderType: enum: - 1 - 2 type: integer x-enum-comments: OrderTypeCoin: 金币购买 OrderTypeVip: 会员购买 x-enum-varnames: - OrderTypeVip - OrderTypeCoin vipordermod.VipOrder: properties: amount: 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 id: description: 唯一ID type: integer ipAddr: description: 客户端 IP type: string oid: description: 第三方订单号 type: string orderType: allOf: - $ref: '#/definitions/vipordermod.OrderType' description: 订单类型：1会员 2金币 payChannel: description: 支付渠道 type: string payMode: description: 支付方式：overage/alipay/wechat type: string payRate: description: 费率 type: string payUrl: description: 支付链接 type: string payUrlMode: description: 链接打开方式 type: string status: allOf: - $ref: '#/definitions/pubdef.VipOrderStatus' description: 订单状态 sysType: description: ios/android type: string tradeNo: description: 本地订单号 type: string updatedAt: description: 更新时间 type: string userId: description: 用户ID type: integer type: object host: https://视频站-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/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: description: 按请求头 X-User-Agent 中的 devID 识别用户，返回最新用户信息，包含金币余额、VIP状态等 produces: - application/json responses: "200": description: 用户信息 schema: $ref: '#/definitions/authser.LoginResp' "400": description: 失败 schema: type: string summary: 获取当前用户信息 tags: - 用户认证 /api/app/auth/profile: post: consumes: - application/json description: 按请求头 X-User-Agent 中的 devID 识别用户；nickName、avatar、introduction、privacyMode 均为可选，至少提供一项。 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/coin/buy: post: consumes: - application/json description: 根据指定金币套餐发起第三方支付，返回支付链接 parameters: - description: 购买参数 in: body name: param required: true schema: $ref: '#/definitions/coinapi.buyCoinReq' produces: - application/json responses: "200": description: 支付链接 schema: $ref: '#/definitions/coinser.BuyCoinResp' security: - ApiKeyAuth: [] summary: 购买金币 tags: - 金币 /api/app/coin/orders: get: parameters: - description: 页码（默认1） in: query name: page type: integer - description: 每页数量（默认10） in: query name: pageSize type: integer produces: - application/json responses: "200": description: 订单列表 schema: type: object security: - ApiKeyAuth: [] summary: 查询金币购买记录 tags: - 金币 /api/app/coin/trans/list: get: description: 返回当前登录用户的金币收入、支出流水，按交易时间倒序 parameters: - description: 页码（默认1） in: query name: page type: integer - description: 每页数量（默认10，最大100） in: query name: pageSize type: integer produces: - application/json responses: "200": description: 成功 schema: allOf: - $ref: '#/definitions/response.BasePageResp' - properties: list: items: $ref: '#/definitions/proto.CoinTransListItemResp' type: array type: object security: - ApiKeyAuth: [] summary: 查询金币余额明细 -- by 旺鸣 tags: - 金币 /api/app/comment/like/set: post: consumes: - application/json description: 设置当前用户对短剧评论或短剧剧集评论的点赞状态 parameters: - description: 评论点赞设置请求 in: body name: param required: true schema: $ref: '#/definitions/proto.CommentLikeSetReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.CommentLikeSetResp' "400": description: 获取失败的返回结果 schema: type: string security: - ApiKeyAuth: [] summary: 评论点赞/取消点赞 --by 王鸣 tags: - 评论APP /api/app/comment/list: get: consumes: - application/json description: 分页查询短剧或短剧剧集评论树，一级评论分页返回，二级评论挂在children中，objectType 10-短剧 11-短剧剧集 parameters: - description: 对象ID（短剧id 短剧剧集id） in: query name: objectId required: true type: integer - description: 对象类型 10-短剧 11-短剧剧集 in: query name: objectType required: true type: integer - in: query name: pageNum type: integer - in: query name: pageSize type: integer - description: 排序 1-热门，按点赞数倒序 2-最新，按创建时间倒序 in: query name: sortOrder type: integer produces: - application/json responses: "200": description: 成功 schema: allOf: - $ref: '#/definitions/proto.GetCommentListResp' - 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: 发布短剧或短剧剧集评论，parentsId为0发布一级评论，大于0发布二级评论，replyCommentId表示实际回复的评论，objectType 10-短剧 11-短剧剧集 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/info: get: consumes: - application/json description: 返回最新地址信息、完整系统配置、广告配置和全站SEO配置 produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.ConfigInfoResp' "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/contactus/add: post: consumes: - application/json description: 用户提交联系我们表单，问题类型：1-订单问题、2-账号问题、3-功能问题、4-体验问题、5-其他 parameters: - description: 联系我们请求 in: body name: param required: true schema: $ref: '#/definitions/proto.ContactUsAddReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.ContactUsAddResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: 提交联系我们 -- by 旺鸣 tags: - 联系我们相关接口 /api/app/feedback/add: post: consumes: - application/json description: 用户提交意见反馈，问题类型，1-功能建议、2-播放问题、3-账号问题、4-其他 parameters: - description: 意见反馈请求 in: body name: param required: true schema: $ref: '#/definitions/proto.FeedbackReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.FeedbackResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: 提交意见反馈 -- by 旺鸣 tags: - 意见反馈相关接口 /api/app/playlet/chapter/collect/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: $ref: '#/definitions/proto.PlayletChapterCollectListResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端我的短剧剧集收藏列表 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/chapter/collect/set: post: consumes: - application/json description: 设置当前用户短剧剧集收藏状态，收藏数只在状态真实变化时增减 parameters: - description: 短剧剧集收藏设置请求 in: body name: param required: true schema: $ref: '#/definitions/proto.PlayletChapterCollectSetReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletChapterCollectSetResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端短剧剧集收藏/取消收藏 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/chapter/detail: get: description: 根据短剧剧集ID查询播放页当前剧集详情；可传playletId或playletSlug校验剧集归属，slug非空时优先解析短剧ID parameters: - description: 短剧剧集ID in: query name: chapterId required: true type: integer - description: 短剧ID，传入时用于校验剧集归属 in: query name: playletId type: integer - description: 短剧slug，非空时优先按slug解析短剧ID in: query name: playletSlug type: string produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletChapterInfoResp' "400": description: 失败 schema: type: string summary: app端根据ID查询短剧剧集详情 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/chapter/like/set: post: consumes: - application/json description: 设置当前用户短剧剧集点赞状态，点赞数只在状态真实变化时增减 parameters: - description: 短剧剧集点赞设置请求 in: body name: param required: true schema: $ref: '#/definitions/proto.PlayletChapterLikeSetReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletChapterLikeSetResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端短剧剧集点赞/取消点赞 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/chapter/list: get: description: 根据短剧ID或slug查询右侧选集列表；slug非空时优先按slug解析短剧ID parameters: - description: 短剧ID in: query name: playletId type: integer - description: 短剧slug，非空时优先按slug解析短剧ID in: query name: playletSlug type: string produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletChapterListResp' "400": description: 失败 schema: type: string summary: app端根据短剧ID查询剧集列表 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/chapter/unlock: post: consumes: - application/json description: 仅金币付费剧集可调用；接口具备幂等性，已解锁剧集重复调用不会重复扣金币 parameters: - description: 短剧剧集金币解锁请求 in: body name: param required: true schema: $ref: '#/definitions/proto.PlayletChapterUnlockReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletChapterUnlockResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端使用金币逐集解锁短剧剧集 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/chapter/watch/report: post: consumes: - application/json description: 上报当前用户短剧剧集播放进度，达到已看条件时用于我的收藏未看集数计算 parameters: - description: 短剧剧集观看上报请求 in: body name: param required: true schema: $ref: '#/definitions/proto.PlayletChapterWatchReportReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletChapterWatchReportResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端短剧剧集观看上报 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/collect/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: $ref: '#/definitions/proto.PlayletCollectListResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端我的短剧收藏列表 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/collect/set: post: consumes: - application/json description: 设置当前用户短剧收藏状态，收藏数只在状态真实变化时增减 parameters: - description: 短剧收藏设置请求 in: body name: param required: true schema: $ref: '#/definitions/proto.PlayletCollectSetReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletCollectSetResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端短剧收藏/取消收藏 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/detail: get: description: 根据短剧ID或slug查询已上架短剧详情；slug非空时优先按slug解析短剧ID 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: $ref: '#/definitions/proto.PlayletInfoResp' "400": description: 失败 schema: type: string summary: app端根据ID查询短剧详情 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/forward/heat: post: consumes: - application/json description: 请求一次短剧热度值增加5，仅支持已上架短剧 parameters: - description: 短剧转发加热度请求 in: body name: param required: true schema: $ref: '#/definitions/proto.PlayletForwardHeatReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletForwardHeatResp' "400": description: 失败 schema: type: string summary: app端短剧转发增加热度 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/history/clear: post: consumes: - application/json description: 仅清空观看历史，不影响收藏列表和观看进度 produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletHistoryClearResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端清空我的短剧观看历史 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/history/list: get: consumes: - application/json description: 按当前用户最近观看时间倒序分页返回短剧观看历史；pageSize默认20、最大100 parameters: - in: query name: pageNum type: integer - in: query name: pageSize type: integer produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletHistoryListResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端我的短剧观看历史列表 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/home: get: consumes: - application/json description: 无请求参数，返回首页banner、最近更新和启用短剧分类数据；homeCategoryData按分类rank倒序返回全部启用分类，每个分类最多16条短剧 produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.HomePlayletResponse' "400": description: 失败 schema: type: string summary: app端首页短剧接口 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/hot-like: get: consumes: - application/json description: 返回缓存的前10个热搜词，以及按收藏量最多的15部猜你喜欢短剧 produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletHotLikeResp' "400": description: 失败 schema: type: string summary: app端热搜词和猜你喜欢 tags: - app短剧相关接口 /api/app/playlet/like/set: post: consumes: - application/json description: 设置当前用户短剧点赞状态，点赞数只在状态真实变化时增减 parameters: - description: 短剧点赞设置请求 in: body name: param required: true schema: $ref: '#/definitions/proto.PlayletLikeSetReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletLikeSetResp' "400": description: 失败 schema: type: string security: - ApiKeyAuth: [] summary: app端短剧点赞/取消点赞 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/list: get: consumes: - application/json description: 分页查询已上架短剧；可按题材ID或题材slug筛选，slug非空时优先按slug解析题材ID parameters: - in: query name: pageNum type: integer - in: query name: pageSize type: integer - description: 排序 1-热度优先，按收藏量倒序 2-今日更新，按上架时间倒序 in: query name: sortOrder type: integer - description: 题材ID in: query name: themeId type: integer - description: 题材slug，非空时优先按slug解析题材ID in: query name: themeSlug type: string produces: - application/json responses: "200": description: 成功 schema: allOf: - $ref: '#/definitions/proto.PlayletVideoResp' - properties: list: items: $ref: '#/definitions/proto.CommonData' type: array type: object "400": description: 失败 schema: type: string summary: 短剧 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/operate/list: get: consumes: - application/json description: 按运营类型查询已上架短剧；operateType=1短剧 2漫剧；filterType=1最近更新(按上架时间) 2当前热播(按收藏数) 3独家原创(原创且按推荐排序) parameters: - description: 筛选类型 1-最近更新 2-当前热播 3-独家原创 in: query name: filterType type: integer - description: 运营类型 1-短剧 2-漫剧 in: query name: operateType type: integer - in: query name: pageNum type: integer - in: query name: pageSize type: integer produces: - application/json responses: "200": description: 成功 schema: allOf: - $ref: '#/definitions/proto.PlayletOperateListResp' - properties: list: items: $ref: '#/definitions/proto.CommonData' type: array type: object "400": description: 失败 schema: type: string summary: app端按运营类型分页查询短剧 tags: - app短剧相关接口 /api/app/playlet/rank: get: consumes: - application/json description: 分页查询已上架短剧排行榜；sortOrder=1按热度值倒序，2按上架时间倒序，3按收藏数倒序 parameters: - in: query name: pageNum type: integer - in: query name: pageSize type: integer - description: 排序 1-热播榜，按热度值倒序 2-新剧榜，按上架时间倒序 3-追剧榜，按收藏数倒序 in: query name: sortOrder type: integer produces: - application/json responses: "200": description: 成功 schema: allOf: - $ref: '#/definitions/proto.PlayletRankResp' - properties: list: items: $ref: '#/definitions/proto.CommonData' type: array type: object "400": description: 失败 schema: type: string summary: 短剧排行榜 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/recommend/list: get: consumes: - application/json description: 根据短剧分类ID或分类slug分页查询已上架短剧；slug非空时优先按slug解析分类ID；pageSize默认10、最大100 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.PlayletRecommendListResp' - properties: list: items: $ref: '#/definitions/proto.CommonData' type: array type: object "400": description: 失败 schema: type: string summary: app端分页查询分类短剧（更多） --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/search: get: consumes: - application/json description: 使用ES分页搜索已上架短剧，支持剧名、题材名、简介和标签名检索 parameters: - description: 搜索关键词，支持剧名、题材名、简介和标签名 in: query name: keyword 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.PlayletSearchResp' - properties: list: items: $ref: '#/definitions/proto.CommonData' type: array type: object "400": description: 失败 schema: type: string summary: app端ES分页搜索短剧 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/tag/list: get: consumes: - application/json description: 根据标签ID或标签slug分页查询已上架短剧；slug非空时优先按slug解析标签ID parameters: - in: query name: pageNum type: integer - in: query name: pageSize 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.PlayletTagVideoResp' - properties: list: items: $ref: '#/definitions/proto.CommonData' type: array type: object "400": description: 失败 schema: type: string summary: app端根据标签ID分页查询短剧 --by 王鸣 tags: - app短剧相关接口 /api/app/playlet/today-update: 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.PlayletTodayUpdateResp' - properties: list: items: $ref: '#/definitions/proto.CommonData' type: array type: object "400": description: 失败 schema: type: string summary: app端分页查询今日更新短剧 --by 王鸣 tags: - app短剧相关接口 /api/app/recharge/package/list: get: description: 返回会员畅享和金币充值两个列表，并附带各套餐可用支付方式 produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.RechargePackageListResp' summary: 查询购买套餐列表 -- by 王鸣 tags: - 金币与会员 /api/app/statcenter/sync: post: consumes: - application/json description: 按 job 拉取注册/日活/充值/绑定/消费/售卡等增量数据 parameters: - description: 参数 in: body name: param required: true schema: $ref: '#/definitions/statcenter.StatcenterSyncReq' produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/statcenter.StatcenterSyncResp' "400": description: 失败 schema: type: string summary: 统计中心增量同步 tags: - 数据同步 /api/app/theme/list: get: consumes: - application/json description: 无请求参数，不分页，返回已上架题材列表 produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.PlayletThemeListResponse' "400": description: 失败 schema: type: string summary: app端短剧题材列表 --by 王鸣 tags: - app短剧题材相关接口 /api/app/translation/category/list: get: consumes: - application/json description: 无请求参数，不分页，返回启用的顶部导航分类 produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/proto.AppTranslationInfo' "400": description: 失败 schema: type: string summary: app端导航分类列表 --by 王鸣 tags: - APP导航相关接口 /api/app/upload/image: post: consumes: - multipart/form-data description: 将图片转发至存储服务 /media/web/autopublish/image parameters: - description: 图片文件 in: formData name: file required: true type: file - description: 是否加水印：1加，其他情况不加（头像不加） in: formData name: watermark type: string produces: - application/json responses: "200": description: 成功 schema: $ref: '#/definitions/uploadser.ImageUploadResp' "400": description: 参数错误 schema: type: string summary: 图片上传 tags: - 上传 /api/app/video/detail: get: consumes: - application/json description: 查询已上架视频详情和该视频相关推荐列表 parameters: - description: 视频的id必填 in: query name: id required: true type: integer produces: - application/json responses: "200": description: 成功 schema: allOf: - $ref: '#/definitions/proto.VideoInfoResp' - properties: recommendVideos: items: $ref: '#/definitions/proto.VideoItemResp' type: array type: object "400": description: 失败 schema: type: string summary: 查询视频详情 --by 旺鸣 tags: - 视频相关接口 /api/app/video/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.VideoResp' - properties: list: items: $ref: '#/definitions/proto.VideoItemResp' type: array type: object "400": description: 失败 schema: type: string summary: 普通分页查询视频 --by 旺鸣 tags: - 视频相关接口 /api/app/vip/orders: get: consumes: - application/json parameters: - description: 页码（默认1） in: query name: page type: integer - description: 每页数量（默认10） in: query name: pageSize type: integer produces: - application/json responses: "200": description: 订单列表 schema: items: $ref: '#/definitions/vipordermod.VipOrder' type: array security: - ApiKeyAuth: [] summary: 查询 VIP 充值记录 tags: - 充值 /api/app/vip/pay: post: consumes: - application/json parameters: - description: 下单参数 in: body name: param required: true schema: $ref: '#/definitions/rechargeapi.submitOrderReq' produces: - application/json responses: "200": description: 支付链接 schema: $ref: '#/definitions/rechargeser.SubmitOrderResp' security: - ApiKeyAuth: [] summary: 创建 VIP 充值订单（第三方支付） tags: - 充值 /richtext/: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: - 标签搜索 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"