API Reference

基于线上 OpenAPI 3.0 Spec 自动生成(5min 缓存),共 134 个接口

按 Tag 筛选
Open API - 第三方接口 (13)
GET/openapi/v1/post/{postId}
获取帖子详情
参数
名称位置必填说明
postIdpathLong
postTypequery-String
响应 ResponseDTOMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v1/post/batch-detail
批量获取帖子详情
请求体 OpenApiBatchPostDetailParam
字段类型必填说明
postIdsarray<integer>帖子 ID 列表(最多 20 条)
响应 ResponseDTOListMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<object>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/post/query
查询帖子列表
响应 ResponseDTOPageResultMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultMapStringObject--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/resource/{postId}
获取资源详情
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v1/resource/{postId}/download-auth
生成下载授权
参数
名称位置必填说明
postIdpathLong
请求体 BaseDownloadAuthParam
字段类型必填说明
fileInfoIdint64文件信息 ID(不传则下载默认文件)
proxyUserIdint64-代理用户 ID(可选,需具备代理权限)
响应 ResponseDTODownloadAuthVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataDownloadAuthVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/resource/{postId}/files
获取资源文件列表
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<object>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/resource/{postId}/install-config
获取安装配置
参数
名称位置必填说明
postIdpathLong
fileInfoIdquery-Long
响应 ResponseDTOInstallConfigVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataInstallConfigVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/resource/query
查询资源列表
参数
名称位置必填说明
pageNumqueryInteger
pageSizequeryInteger
sectionCodequery-String
keywordquery-String
响应 ResponseDTOPageResultMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultMapStringObject--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/server/{postId}/status
获取服务器状态
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOOpenApiServerStatusVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiServerStatusVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/server/query
查询服务器列表
参数
名称位置必填说明
pageNumqueryInteger
pageSizequeryInteger
serverStatusquery-String
queryEnabledquery-Boolean
响应 ResponseDTOPageResultMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultMapStringObject--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/stats/forum
获取论坛统计数据
响应 ResponseDTOOpenApiForumStatsVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiForumStatsVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/tags
查询标签列表
参数
名称位置必填说明
sectionCodequery-String
响应 ResponseDTOListMapStringObject
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<object>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v1/user/profile
获取代理用户资料
响应 ResponseDTOOpenApiUserProfileVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiUserProfileVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenAPI v2 - 代理用户账号 / 积分 (5)
GET/openapi/v2/proxy-user/{userId}/points
查询代理用户积分余额(需 X-Proxy-Access-Token)
参数
名称位置必填说明
userIdpathLong
响应 ResponseDTOOpenApiProxyUserPointsVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiProxyUserPointsVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/proxy-user/{userId}/points/adjust
调整代理用户积分(ADD 增加 / DEDUCT 扣减,需 X-Proxy-Access-Token)
参数
名称位置必填说明
userIdpathLong
请求体 OpenApiProxyUserPointsAdjustParam
字段类型必填说明
amountnumber调整金额(始终为正,方向由 direction 决定)
reasonstring调整原因(记录到调整流水)
directionstring enum方向:ADD 增加 / DEDUCT 扣减
响应 ResponseDTOOpenApiProxyUserPointsAdjustVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiProxyUserPointsAdjustVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/proxy-user/{userId}/wallet/{currencyCode}/adjust
调整代理用户任意币种余额(ADD/DEDUCT,白名单同 balance)
参数
名称位置必填说明
userIdpathLong
currencyCodepathString
请求体 OpenApiProxyUserPointsAdjustParam
字段类型必填说明
amountnumber调整金额(始终为正,方向由 direction 决定)
reasonstring调整原因(记录到调整流水)
directionstring enum方向:ADD 增加 / DEDUCT 扣减
响应 ResponseDTOOpenApiProxyUserPointsAdjustVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiProxyUserPointsAdjustVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/proxy-user/{userId}/wallet/{currencyCode}/balance
查询代理用户任意币种余额(白名单:GOLD_COIN/POINTS/CASH,需 X-Proxy-Access-Token)
参数
名称位置必填说明
userIdpathLong
currencyCodepathString
响应 ResponseDTOOpenApiProxyUserPointsVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiProxyUserPointsVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/proxy-user/register
注册代理用户(一键绑定:mzgf 侧当场建号 + 下发 24h 代理令牌)
请求体 OpenApiProxyUserRegisterParam
字段类型必填说明
usernamestring面板侧展示用户名
phonestring-手机号(可空)
emailstring-邮箱(可空)
loginNamestring-用户自选登录名(可空,面板一键绑定时由用户填写)
passwordstring-用户自选密码(可空,面板一键绑定时由用户填写)
externalUserIdstring-第三方系统(调用方)用户唯一标识(可空,非空则写反向绑定)
externalUsernamestring-第三方用户名(展示/审计用,可空)
externalDisplayNamestring-第三方昵称(展示用,可空)
响应 ResponseDTOOpenApiProxyUserRegisterVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiProxyUserRegisterVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenAPI v2 - 第三方用户绑定映射 (2)
POST/openapi/v2/user-binding/link
反向绑定第三方 App 用户(需 X-Proxy-Access-Token,幂等 upsert)
请求体 OpenApiUserBindingLinkParam
字段类型必填说明
externalUserIdstring第三方系统(调用方 App)的用户唯一标识
externalUsernamestring-第三方用户名(展示/审计用,可空)
externalDisplayNamestring-第三方昵称(展示用,可空)
响应 ResponseDTOOpenApiUserBindingVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiUserBindingVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/user-binding/unlink
解绑第三方 App 用户(需 X-Proxy-Access-Token)
请求体 OpenApiUserBindingLinkParam
字段类型必填说明
externalUserIdstring第三方系统(调用方 App)的用户唯一标识
externalUsernamestring-第三方用户名(展示/审计用,可空)
externalDisplayNamestring-第三方昵称(展示用,可空)
响应 ResponseDTOInteger
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataint32-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiCategoryController (14)
GET/openapi/v2/categories/tree
全站资源分类列表(当前为扁平结构,树形组装留待后续)
响应 ResponseDTOListCategoryNodeVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<CategoryNodeVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/category/tree
全站资源分类列表(当前为扁平结构,树形组装留待后续)
响应 ResponseDTOListCategoryNodeVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<CategoryNodeVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/games
板块(游戏)列表(CurseForge: list games)
响应 ResponseDTOListSectionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<SectionVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/games/{sectionCode}
板块(游戏)详情
参数
名称位置必填说明
sectionCodepathString
响应 ResponseDTOSectionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataSectionVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/games/{sectionCode}/filter-options
板块维度资源筛选选项(资源类型→主要类别两级联动 + 运行平台)
参数
名称位置必填说明
sectionCodepathString
响应 ResponseDTOSectionFilterOptionsVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataSectionFilterOptionsVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mod-loaders
运行平台列表(CurseForge: mod loaders)
响应 ResponseDTOListRunPlatformVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<RunPlatformVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mod-loaders/{code}
运行平台详情
参数
名称位置必填说明
codepathString
响应 ResponseDTORunPlatformVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataRunPlatformVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/run-platform/{code}
运行平台详情
参数
名称位置必填说明
codepathString
响应 ResponseDTORunPlatformVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataRunPlatformVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/run-platform/list
运行平台列表(CurseForge: mod loaders)
响应 ResponseDTOListRunPlatformVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<RunPlatformVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/section/{sectionCode}
板块(游戏)详情
参数
名称位置必填说明
sectionCodepathString
响应 ResponseDTOSectionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataSectionVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/section/{sectionCode}/filter-options
板块维度资源筛选选项(资源类型→主要类别两级联动 + 运行平台)
参数
名称位置必填说明
sectionCodepathString
响应 ResponseDTOSectionFilterOptionsVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataSectionFilterOptionsVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/section/list
板块(游戏)列表(CurseForge: list games)
响应 ResponseDTOListSectionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<SectionVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/stats/games/{sectionCode}
板块维度统计(资源数 + 累计浏览/下载/点赞/收藏聚合)
参数
名称位置必填说明
sectionCodepathString
响应 ResponseDTOSectionStatsVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataSectionStatsVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/stats/section/{sectionCode}
板块维度统计(资源数 + 累计浏览/下载/点赞/收藏聚合)
参数
名称位置必填说明
sectionCodepathString
响应 ResponseDTOSectionStatsVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataSectionStatsVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiCommunityMessageController (4)
POST/openapi/v2/community/message/send
发送私信(代理用户场景)
请求体 BaseOpenApiMessageSendParam
字段类型必填说明
toUserIdint64收信用户 ID
contentstring私信内容
响应 ResponseDTOOpenApiPrivateMessageResultVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiPrivateMessageResultVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/notifications
查询代理用户站内消息列表
参数
名称位置必填说明
readFlagquery-Boolean
响应 ResponseDTOPageResultMessageVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultMessageVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/community/notifications/read
标记代理用户站内消息已读
请求体 OpenApiNotificationReadParam
字段类型必填说明
messageIdsarray<integer>待标记已读的消息 ID 列表
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/notifications/unread-count
查询代理用户未读消息数
响应 ResponseDTOLong
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataint64-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiCommunityReadController (8)
GET/openapi/v2/community/comments
查询通用评论列表(按 entityType + entityId)
响应 ResponseDTOPageResultCommentVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommentVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/discuss/{postId}
查询讨论帖详情
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOCommunityPostDetailVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataCommunityPostDetailVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/discuss/query
查询讨论帖列表
响应 ResponseDTOPageResultCommunityPostSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommunityPostSummaryVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/moment/{momentId}
查询瞬间(动态)详情
参数
名称位置必填说明
momentIdpathLong
响应 ResponseDTOCommunityMomentVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataCommunityMomentVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/moment/query
查询瞬间(动态)列表
响应 ResponseDTOPageResultCommunityMomentVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommunityMomentVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/question/{postId}
查询问答帖详情
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOCommunityQuestionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataCommunityQuestionVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/question/{postId}/answers
查询问答帖回答列表
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOPageResultCommunityAnswerVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommunityAnswerVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/question/query
查询问答帖列表
响应 ResponseDTOPageResultCommunityQuestionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommunityQuestionVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiCommunitySearchController (2)
GET/openapi/v2/community/search
全站全文搜索
响应 ResponseDTOPageResultLuceneSearchResultVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultLuceneSearchResultVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/search/suggest
搜索联想(前缀补全)
参数
名称位置必填说明
keywordqueryString
响应 ResponseDTOListString
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<string>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiCommunityUserController (4)
GET/openapi/v2/community/user/{userId}
查询用户公开主页
参数
名称位置必填说明
userIdpathLong
响应 ResponseDTOCommunityUserProfileVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataCommunityUserProfileVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/user/{userId}/followers
查询用户粉丝列表
参数
名称位置必填说明
userIdpathLong
响应 ResponseDTOPageResultCommunityFollowUserVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommunityFollowUserVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/user/{userId}/following
查询用户关注列表
参数
名称位置必填说明
userIdpathLong
响应 ResponseDTOPageResultCommunityFollowUserVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommunityFollowUserVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/community/user/{userId}/posts
查询用户作品(讨论帖)列表
参数
名称位置必填说明
userIdpathLong
响应 ResponseDTOPageResultCommunityPostSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommunityPostSummaryVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiCommunityWriteController (4)
POST/openapi/v2/community/collect
收藏 toggle(代理用户场景)
请求体 BaseOpenApiInteractionParam
字段类型必填说明
entityTypestring目标实体类型:DISCUSS_POST / QUESTION_POST / USER_MOMENT / RESOURCE_POST / POST_COMMENT
entityIdint64目标实体 ID
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/community/comment
发布评论 / 回复(代理用户场景)
请求体 BaseOpenApiCommentPublishParam
字段类型必填说明
entityTypestring根实体类型:DISCUSS_POST / QUESTION_POST / USER_MOMENT / RESOURCE_POST
entityIdint64根实体 ID(帖子 / 瞬间 ID)
contentstring评论内容
parentCommentIdint64-父评论 ID(回复场景传入,顶层评论留空)
mentionedUserIdsarray<integer>-@提及的用户 ID 列表(最多 10 个)
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/community/follow
关注 / 取关 toggle(代理用户场景)
请求体 BaseOpenApiFollowParam
字段类型必填说明
targetUserIdint64目标用户 ID
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/community/like
点赞 toggle(代理用户场景)
请求体 BaseOpenApiInteractionParam
字段类型必填说明
entityTypestring目标实体类型:DISCUSS_POST / QUESTION_POST / USER_MOMENT / RESOURCE_POST / POST_COMMENT
entityIdint64目标实体 ID
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiOAuthController (3)
POST/openapi/v2/oauth/revoke
吊销代理用户访问令牌
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/oauth/token
颁发代理用户访问令牌(24h 有效)
请求体 OpenApiAccessTokenIssueParam
字段类型必填说明
userIdint64目标代理用户 ID(用户必须已在 biz 前端授权页完成确认,并生成对应授权 code)
authCodestringbiz 前端授权页输出的 6 位授权码(仅大写字母与数字,5 分钟内有效)
requestedScopesarray<string>-申请的权限 scope 列表(必须是该 App 已审核通过的权限点子集,与 OpenApiConstant.PERMISSION 对齐)。可空,空时不下发 scope 限制。
响应 ResponseDTOOpenApiAccessTokenVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiAccessTokenVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/pairing/redeem
凭配对码换发代理令牌(面板配对:用户在社区生成配对码,面板换取代表其下载已购资源的令牌)
请求体 OpenApiPairingRedeemParam
字段类型必填说明
pairingCodestring用户在社区生成的 8 位配对码(仅大写字母与数字,1 天内有效)
响应 ResponseDTOOpenApiAccessTokenVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiAccessTokenVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiProviderActivityWriteController (2)
POST/openapi/v2/provider/activity/carousel
服务商花活动积分自助投放轮播(免审直上,图片自传;代理用户场景)
响应 ResponseDTOServerProviderCarouselResultVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataServerProviderCarouselResultVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/provider/activity/collect
代表已授权用户扣其钱包积分并转入服务商活动积分账户(代理用户场景)
请求体 ServerProviderActivityCollectParam
字段类型必填说明
amountint64转入的积分数量(扣被代理用户钱包 POINTS)
orderNostring-外部业务单号(作幂等键,相同单号重复调用不重复扣款;缺省则每次独立)
remarkstring-备注
响应 ResponseDTOServerProviderActivityCollectResultVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataServerProviderActivityCollectResultVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiResourceController (56)
POST/openapi/v2/file/batch
批量文件查询(最多 50 个;仅返回所属资源公开可见的文件,其余静默过滤)
请求体 OpenApiFileBatchParam
字段类型必填说明
fileInfoIdsarray<integer>文件信息 ID 列表(对应 resource_file_info.info_id;1~50)
响应 ResponseDTOListFileSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<FileSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/files
批量文件查询(最多 50 个;仅返回所属资源公开可见的文件,其余静默过滤)
请求体 OpenApiFileBatchParam
字段类型必填说明
fileInfoIdsarray<integer>文件信息 ID 列表(对应 resource_file_info.info_id;1~50)
响应 ResponseDTOListFileSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<FileSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/files/{fileId}/download-url
单文件下载 URL(外链原始地址;站内 mirror 文件请改用 /download-auth 接口)
参数
名称位置必填说明
postIdpathLong
fileIdpathLong
响应 ResponseDTOFileDownloadUrlVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataFileDownloadUrlVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/modpacks/{postId}/download-failure
消费端资源下载失败上报(cloudexplorer 判定资源本身问题时上报,按 fingerprint 去重累加,达阈值自动隐藏)
参数
名称位置必填说明
postIdpathLong
请求体 DownloadFailureReportParam
字段类型必填说明
fileInfoIdint64-上报的下载文件 ID(install-info 阶段未拿到时可留空)
failureTypestring失败类型:INSTALL_INFO_UNAVAILABLE / UPSTREAM_UNREACHABLE / FILE_INVALID / EXTRACT_FAILED / STRUCTURE_INVALID / SERVER_BOOT_FAILED
resourceVersionstring-上报时的资源版本快照(resource_post.resource_version),用于版本更新后清零判定
errorMsgstring-客户端上报的错误描述(可为空;超过 1000 字符会被截断)
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/modpacks/{postId}/mc-startup-command
Minecraft 一键启动命令(出租等消费端传机器内存,返回带 -Xmx 与 loader 参数的 shell 命令)
参数
名称位置必填说明
postIdpathLong
memoryMbqueryInteger
响应 ResponseDTOMcStartupCommandVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataMcStartupCommandVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/modpacks/{postId}/mc-startup-command
MC 一键启动命令消费端回传(出租等消费端把最终写入面板 startup 的命令+来源回传给上游,用于反哺推断质量)
参数
名称位置必填说明
postIdpathLong
请求体 McStartupCommandReportParam
字段类型必填说明
commandstring实际写入面板 startup 的完整启动命令
sourcestring推断来源:upstream(mzgf openapi 返回) / ai(消费端 AI 生成) / heuristic(启发式) / manual(手填) / unknown
runPlatformstring-运行平台(paper/vanilla/forge/neoforge/fabric/...),可选
mcVersionstring-Minecraft 版本(1.20.1 等),可选
serverTypestring-服务端类型:预留字段,与 runPlatform 语义重合时可留空
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/modpacks/{postId}/user-feedback-report
消费端"是否有用"隐形投票阈值上报(cloudexplorer 侧本地聚合触发, 上报快照供作者通知 + 后台观察)
参数
名称位置必填说明
postIdpathLong
请求体 UserFeedbackReportParam
字段类型必填说明
reportTypestring严重程度: RANK_DOWN (排序下沉阈值) / HIDE (隐藏阈值)
usefulCountint32上报时该 app 侧累计 USEFUL 票数快照 (>=0)
notUsefulCountint32上报时该 app 侧累计 NOT_USEFUL 票数快照 (>=0)
shortTermBadCountint32-上报时短期窗口 NOT_USEFUL 票数快照 (>=0)
resourceVersionstring-上报时资源版本快照 (resource_post.resource_version), 用于新版本自动清零判定
detailstring-客户端上报的补充说明 (可为空, 超 1000 自动截断)
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/modpacks/user-feedback/resolved-since
"是否有用"投票已修复增量列表(cloudexplorer 定时拉取以复位本地隐藏状态)
参数
名称位置必填说明
sincequery起始时间 (ISO-8601, 例如 2026-08-26T00:00:00), 返回 resolvedAt >= since 的活跃反馈
limitquery-Integer
响应 ResponseDTOListUserFeedbackResolvedItemVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<UserFeedbackResolvedItemVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/mods
批量获取资源摘要(最多 50 个 ID,结果按入参顺序返回)
请求体 OpenApiResourceBatchParam
字段类型必填说明
postIdsarray<integer>资源帖子 ID 列表(1~50)
响应 ResponseDTOListModSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<ModSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}
获取资源详情(不含完整描述,描述请走 /description 端点)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOModDetailVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataModDetailVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/authors
资源帖子的作者列表(含 userName / avatarUrl / role)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListAuthorBriefVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<AuthorBriefVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/comments
资源评论列表(分页;仅 status=NORMAL 且未删除;按 createTime 倒序)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOPageResultCommentVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommentVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/description
获取资源完整描述(HTML + Markdown,独立端点避免详情 payload 膨胀)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOModDescriptionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataModDescriptionVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/mods/{postId}/download-failure
消费端资源下载失败上报(cloudexplorer 判定资源本身问题时上报,按 fingerprint 去重累加,达阈值自动隐藏)
参数
名称位置必填说明
postIdpathLong
请求体 DownloadFailureReportParam
字段类型必填说明
fileInfoIdint64-上报的下载文件 ID(install-info 阶段未拿到时可留空)
failureTypestring失败类型:INSTALL_INFO_UNAVAILABLE / UPSTREAM_UNREACHABLE / FILE_INVALID / EXTRACT_FAILED / STRUCTURE_INVALID / SERVER_BOOT_FAILED
resourceVersionstring-上报时的资源版本快照(resource_post.resource_version),用于版本更新后清零判定
errorMsgstring-客户端上报的错误描述(可为空;超过 1000 字符会被截断)
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/files
资源帖子的文件列表(fingerprint 字段为第 2 期产出,当前为 null)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListFileSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<FileSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/files/{fileId}
单文件详情(含下载方式 downInfo 解析;归属校验 postId 必须与文件实际归属一致)
参数
名称位置必填说明
postIdpathLong
fileIdpathLong
响应 ResponseDTOFileDetailVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataFileDetailVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/files/{fileId}/download-file
OpenAPI 直连文件下载(X-API-Key 鉴权,DIRECT_UPLOAD 流式,DIRECT_LINK 302,CLOUD_DISK 拒绝)
参数
名称位置必填说明
postIdpathLong
fileIdpathLong
GET/openapi/v2/mods/{postId}/install-config
资源一键安装配置(解析 installScript JSON + 补齐资源基本字段)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOInstallConfigVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataInstallConfigVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/install-info
资源一键安装信息(完整:含已签名直链 + steam 外部源 + 验证版本;回源 biz。免费资源免登录,付费资源需代理用户且购买门禁)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOOpenApiInstallInfoVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiInstallInfoVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/install-launch
资源一键安装唤起信息(deeplink + 探测 + 下载引导,供调用方渲染按钮)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOInstallLaunchVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataInstallLaunchVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/mc-startup-command
Minecraft 一键启动命令(出租等消费端传机器内存,返回带 -Xmx 与 loader 参数的 shell 命令)
参数
名称位置必填说明
postIdpathLong
memoryMbqueryInteger
响应 ResponseDTOMcStartupCommandVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataMcStartupCommandVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/mods/{postId}/mc-startup-command
MC 一键启动命令消费端回传(出租等消费端把最终写入面板 startup 的命令+来源回传给上游,用于反哺推断质量)
参数
名称位置必填说明
postIdpathLong
请求体 McStartupCommandReportParam
字段类型必填说明
commandstring实际写入面板 startup 的完整启动命令
sourcestring推断来源:upstream(mzgf openapi 返回) / ai(消费端 AI 生成) / heuristic(启发式) / manual(手填) / unknown
runPlatformstring-运行平台(paper/vanilla/forge/neoforge/fabric/...),可选
mcVersionstring-Minecraft 版本(1.20.1 等),可选
serverTypestring-服务端类型:预留字段,与 runPlatform 语义重合时可留空
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/rating
资源评分聚合(平均分 + 总人数 + 1~5 星分布;无评分时各项返回 0)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTORatingAggregateVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataRatingAggregateVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/relations
资源帖子的关系链(依赖 / 不兼容 / 推荐;target 字段为空,请用 /mods 批量接口拉取目标摘要)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListRelationVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<RelationVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/mods/{postId}/user-feedback-report
消费端"是否有用"隐形投票阈值上报(cloudexplorer 侧本地聚合触发, 上报快照供作者通知 + 后台观察)
参数
名称位置必填说明
postIdpathLong
请求体 UserFeedbackReportParam
字段类型必填说明
reportTypestring严重程度: RANK_DOWN (排序下沉阈值) / HIDE (隐藏阈值)
usefulCountint32上报时该 app 侧累计 USEFUL 票数快照 (>=0)
notUsefulCountint32上报时该 app 侧累计 NOT_USEFUL 票数快照 (>=0)
shortTermBadCountint32-上报时短期窗口 NOT_USEFUL 票数快照 (>=0)
resourceVersionstring-上报时资源版本快照 (resource_post.resource_version), 用于新版本自动清零判定
detailstring-客户端上报的补充说明 (可为空, 超 1000 自动截断)
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/{postId}/versions
资源帖子的历史版本列表(仅审批通过的版本,按 versionNumber 倒序)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListVersionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<VersionVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/featured
精选 / 热门资源列表(top 20,按下载数 + 点赞 + 更新时间综合排序)
响应 ResponseDTOListModSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<ModSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/search
查询资源列表(CurseForge: search mods)
响应 ResponseDTOPageResultModSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultModSummaryVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/sync
资源增量同步(按 updateTime cursor 翻页;首次请求 cursor 留空)
响应 ResponseDTOResourceSyncVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataResourceSyncVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/mods/user-feedback/resolved-since
"是否有用"投票已修复增量列表(cloudexplorer 定时拉取以复位本地隐藏状态)
参数
名称位置必填说明
sincequery起始时间 (ISO-8601, 例如 2026-08-26T00:00:00), 返回 resolvedAt >= since 的活跃反馈
limitquery-Integer
响应 ResponseDTOListUserFeedbackResolvedItemVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<UserFeedbackResolvedItemVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}
获取资源详情(不含完整描述,描述请走 /description 端点)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOModDetailVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataModDetailVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/authors
资源帖子的作者列表(含 userName / avatarUrl / role)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListAuthorBriefVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<AuthorBriefVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/comments
资源评论列表(分页;仅 status=NORMAL 且未删除;按 createTime 倒序)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOPageResultCommentVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultCommentVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/description
获取资源完整描述(HTML + Markdown,独立端点避免详情 payload 膨胀)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOModDescriptionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataModDescriptionVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/{postId}/download-auth
下载签名授权(站内 mirror 文件;颁发临时下载 token;fileId 在 body 里)
参数
名称位置必填说明
postIdpathLong
请求体 BaseDownloadAuthParam
字段类型必填说明
fileInfoIdint64文件信息 ID(不传则下载默认文件)
proxyUserIdint64-代理用户 ID(可选,需具备代理权限)
响应 ResponseDTODownloadAuthVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataDownloadAuthVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/{postId}/download-failure
消费端资源下载失败上报(cloudexplorer 判定资源本身问题时上报,按 fingerprint 去重累加,达阈值自动隐藏)
参数
名称位置必填说明
postIdpathLong
请求体 DownloadFailureReportParam
字段类型必填说明
fileInfoIdint64-上报的下载文件 ID(install-info 阶段未拿到时可留空)
failureTypestring失败类型:INSTALL_INFO_UNAVAILABLE / UPSTREAM_UNREACHABLE / FILE_INVALID / EXTRACT_FAILED / STRUCTURE_INVALID / SERVER_BOOT_FAILED
resourceVersionstring-上报时的资源版本快照(resource_post.resource_version),用于版本更新后清零判定
errorMsgstring-客户端上报的错误描述(可为空;超过 1000 字符会被截断)
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/file/{fileId}
单文件详情(含下载方式 downInfo 解析;归属校验 postId 必须与文件实际归属一致)
参数
名称位置必填说明
postIdpathLong
fileIdpathLong
响应 ResponseDTOFileDetailVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataFileDetailVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/file/{fileId}/download-file
OpenAPI 直连文件下载(X-API-Key 鉴权,DIRECT_UPLOAD 流式,DIRECT_LINK 302,CLOUD_DISK 拒绝)
参数
名称位置必填说明
postIdpathLong
fileIdpathLong
GET/openapi/v2/resource/{postId}/file/{fileId}/download-url
单文件下载 URL(外链原始地址;站内 mirror 文件请改用 /download-auth 接口)
参数
名称位置必填说明
postIdpathLong
fileIdpathLong
响应 ResponseDTOFileDownloadUrlVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataFileDownloadUrlVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/files
资源帖子的文件列表(fingerprint 字段为第 2 期产出,当前为 null)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListFileSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<FileSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/install-config
资源一键安装配置(解析 installScript JSON + 补齐资源基本字段)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOInstallConfigVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataInstallConfigVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/install-info
资源一键安装信息(完整:含已签名直链 + steam 外部源 + 验证版本;回源 biz。免费资源免登录,付费资源需代理用户且购买门禁)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOOpenApiInstallInfoVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiInstallInfoVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/install-launch
资源一键安装唤起信息(deeplink + 探测 + 下载引导,供调用方渲染按钮)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOInstallLaunchVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataInstallLaunchVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/mc-startup-command
Minecraft 一键启动命令(出租等消费端传机器内存,返回带 -Xmx 与 loader 参数的 shell 命令)
参数
名称位置必填说明
postIdpathLong
memoryMbqueryInteger
响应 ResponseDTOMcStartupCommandVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataMcStartupCommandVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/{postId}/mc-startup-command
MC 一键启动命令消费端回传(出租等消费端把最终写入面板 startup 的命令+来源回传给上游,用于反哺推断质量)
参数
名称位置必填说明
postIdpathLong
请求体 McStartupCommandReportParam
字段类型必填说明
commandstring实际写入面板 startup 的完整启动命令
sourcestring推断来源:upstream(mzgf openapi 返回) / ai(消费端 AI 生成) / heuristic(启发式) / manual(手填) / unknown
runPlatformstring-运行平台(paper/vanilla/forge/neoforge/fabric/...),可选
mcVersionstring-Minecraft 版本(1.20.1 等),可选
serverTypestring-服务端类型:预留字段,与 runPlatform 语义重合时可留空
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/rating
资源评分聚合(平均分 + 总人数 + 1~5 星分布;无评分时各项返回 0)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTORatingAggregateVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataRatingAggregateVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/relations
资源帖子的关系链(依赖 / 不兼容 / 推荐;target 字段为空,请用 /mods 批量接口拉取目标摘要)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListRelationVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<RelationVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/{postId}/user-feedback-report
消费端"是否有用"隐形投票阈值上报(cloudexplorer 侧本地聚合触发, 上报快照供作者通知 + 后台观察)
参数
名称位置必填说明
postIdpathLong
请求体 UserFeedbackReportParam
字段类型必填说明
reportTypestring严重程度: RANK_DOWN (排序下沉阈值) / HIDE (隐藏阈值)
usefulCountint32上报时该 app 侧累计 USEFUL 票数快照 (>=0)
notUsefulCountint32上报时该 app 侧累计 NOT_USEFUL 票数快照 (>=0)
shortTermBadCountint32-上报时短期窗口 NOT_USEFUL 票数快照 (>=0)
resourceVersionstring-上报时资源版本快照 (resource_post.resource_version), 用于新版本自动清零判定
detailstring-客户端上报的补充说明 (可为空, 超 1000 自动截断)
响应 ResponseDTOVoid
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataobject-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/{postId}/versions
资源帖子的历史版本列表(仅审批通过的版本,按 versionNumber 倒序)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOListVersionVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<VersionVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/batch
批量获取资源摘要(最多 50 个 ID,结果按入参顺序返回)
请求体 OpenApiResourceBatchParam
字段类型必填说明
postIdsarray<integer>资源帖子 ID 列表(1~50)
响应 ResponseDTOListModSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<ModSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/featured
精选 / 热门资源列表(top 20,按下载数 + 点赞 + 更新时间综合排序)
响应 ResponseDTOListModSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<ModSummaryVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/query
查询资源列表(CurseForge: search mods)
响应 ResponseDTOPageResultModSummaryVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataPageResultModSummaryVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/sync
资源增量同步(按 updateTime cursor 翻页;首次请求 cursor 留空)
响应 ResponseDTOResourceSyncVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataResourceSyncVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/resource/user-feedback/resolved-since
"是否有用"投票已修复增量列表(cloudexplorer 定时拉取以复位本地隐藏状态)
参数
名称位置必填说明
sincequery起始时间 (ISO-8601, 例如 2026-08-26T00:00:00), 返回 resolvedAt >= since 的活跃反馈
limitquery-Integer
响应 ResponseDTOListUserFeedbackResolvedItemVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataarray<UserFeedbackResolvedItemVO>-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/stats/mods/{postId}
单资源统计(累计浏览/下载/点赞/收藏/评论 + 平均评分)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOResourceStatsDetailVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataResourceStatsDetailVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/stats/resource/{postId}
单资源统计(累计浏览/下载/点赞/收藏/评论 + 平均评分)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOResourceStatsDetailVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataResourceStatsDetailVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiResourceWriteController (8)
POST/openapi/v2/mods/{postId}/edit
编辑已发布资源帖子(强制审批;代理用户场景)
参数
名称位置必填说明
postIdpathLong
请求体 BaseOpenApiResourceSaveParam
字段类型必填说明
postIdint64-帖子ID(编辑时使用)
mainNamestring资源主名称
subNamestring-资源次名称
mainCategorystring-主要类别(支持多个,用逗号分隔,最多5个)
presetCategorystring-预设类目(SAVE_GAME/CHALLENGE_CONFIG/GRAPHICS_PRESET),可选;普通资源传 null
abbrNamestring-缩写名称
introductionstring-资源简介
coverFileIdstring-封面文件ID
mdContentstringMarkdown格式内容
contentstring-普通文本内容
sectionCodestring板块代码
gameTypeIdint64-游戏类型ID
resourceTypeIdint64资源类型ID
runPlatformIdint64-运行平台ID
contentCopyrightIdint64-内容版权ID
contentCopyrightstring-内容版权协议
resourceCopyrightIdint64-资源版权ID
resourceCopyrightstring-资源开源协议
resourceVersionstring-资源版本
authorsstring作者信息(JSON 数组字符串)
postTagsarray<string>-帖子标签列表
postTypeIdstring-资源帖子类型ID
clientEnvironmentstring客户端运行环境
serverEnvironmentstring服务端运行环境
resourceStatestring资源状态
sourceStatestring开源状态
relationResourceRelationParam--
installScriptstring-安装脚本
creationTypestring创作类型
refLinkstring-参考链接(JSON数组字符串)
resourceRelatearray<BaseOpenApiResourceRelateParam>-资源关联列表
resourceFileInfoVosarray<BaseOpenApiResourceFileInfoParam>-资源文件信息列表
imagesarray<string>-媒体图片文件ID列表
tempIdstring-临时ID(用于文件迁移)
updateCommitstring-更新说明
rewardEnabledboolean-是否开启打赏激励
visibilitystring-可见范围(PUBLIC/PRIVATE)
isPaidboolean-是否付费资源
priceCurrencyCodestring-价格货币代码
priceAmountnumber-价格金额
isAllEditboolean-是否公开编辑
memberEnabledboolean-是否开启项目成员功能
isNewDraftboolean-是否为新建草稿(true=新建草稿,false/null=更新已有草稿)
parentPostIdint64-父帖子ID(编辑已发布帖子时传入原帖ID,用于创建EDIT类型草稿)
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/mods/draft/{draftId}/publish
从草稿发布资源帖子(含审批流转;代理用户场景)
参数
名称位置必填说明
draftIdpathLong
请求体 BaseOpenApiResourceSaveParam
字段类型必填说明
postIdint64-帖子ID(编辑时使用)
mainNamestring资源主名称
subNamestring-资源次名称
mainCategorystring-主要类别(支持多个,用逗号分隔,最多5个)
presetCategorystring-预设类目(SAVE_GAME/CHALLENGE_CONFIG/GRAPHICS_PRESET),可选;普通资源传 null
abbrNamestring-缩写名称
introductionstring-资源简介
coverFileIdstring-封面文件ID
mdContentstringMarkdown格式内容
contentstring-普通文本内容
sectionCodestring板块代码
gameTypeIdint64-游戏类型ID
resourceTypeIdint64资源类型ID
runPlatformIdint64-运行平台ID
contentCopyrightIdint64-内容版权ID
contentCopyrightstring-内容版权协议
resourceCopyrightIdint64-资源版权ID
resourceCopyrightstring-资源开源协议
resourceVersionstring-资源版本
authorsstring作者信息(JSON 数组字符串)
postTagsarray<string>-帖子标签列表
postTypeIdstring-资源帖子类型ID
clientEnvironmentstring客户端运行环境
serverEnvironmentstring服务端运行环境
resourceStatestring资源状态
sourceStatestring开源状态
relationResourceRelationParam--
installScriptstring-安装脚本
creationTypestring创作类型
refLinkstring-参考链接(JSON数组字符串)
resourceRelatearray<BaseOpenApiResourceRelateParam>-资源关联列表
resourceFileInfoVosarray<BaseOpenApiResourceFileInfoParam>-资源文件信息列表
imagesarray<string>-媒体图片文件ID列表
tempIdstring-临时ID(用于文件迁移)
updateCommitstring-更新说明
rewardEnabledboolean-是否开启打赏激励
visibilitystring-可见范围(PUBLIC/PRIVATE)
isPaidboolean-是否付费资源
priceCurrencyCodestring-价格货币代码
priceAmountnumber-价格金额
isAllEditboolean-是否公开编辑
memberEnabledboolean-是否开启项目成员功能
isNewDraftboolean-是否为新建草稿(true=新建草稿,false/null=更新已有草稿)
parentPostIdint64-父帖子ID(编辑已发布帖子时传入原帖ID,用于创建EDIT类型草稿)
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/mods/draft/{draftId}/save
保存资源帖子草稿(draftId=0 表示新建草稿;代理用户场景)
参数
名称位置必填说明
draftIdpathLong
请求体 BaseOpenApiResourceSaveParam
字段类型必填说明
postIdint64-帖子ID(编辑时使用)
mainNamestring资源主名称
subNamestring-资源次名称
mainCategorystring-主要类别(支持多个,用逗号分隔,最多5个)
presetCategorystring-预设类目(SAVE_GAME/CHALLENGE_CONFIG/GRAPHICS_PRESET),可选;普通资源传 null
abbrNamestring-缩写名称
introductionstring-资源简介
coverFileIdstring-封面文件ID
mdContentstringMarkdown格式内容
contentstring-普通文本内容
sectionCodestring板块代码
gameTypeIdint64-游戏类型ID
resourceTypeIdint64资源类型ID
runPlatformIdint64-运行平台ID
contentCopyrightIdint64-内容版权ID
contentCopyrightstring-内容版权协议
resourceCopyrightIdint64-资源版权ID
resourceCopyrightstring-资源开源协议
resourceVersionstring-资源版本
authorsstring作者信息(JSON 数组字符串)
postTagsarray<string>-帖子标签列表
postTypeIdstring-资源帖子类型ID
clientEnvironmentstring客户端运行环境
serverEnvironmentstring服务端运行环境
resourceStatestring资源状态
sourceStatestring开源状态
relationResourceRelationParam--
installScriptstring-安装脚本
creationTypestring创作类型
refLinkstring-参考链接(JSON数组字符串)
resourceRelatearray<BaseOpenApiResourceRelateParam>-资源关联列表
resourceFileInfoVosarray<BaseOpenApiResourceFileInfoParam>-资源文件信息列表
imagesarray<string>-媒体图片文件ID列表
tempIdstring-临时ID(用于文件迁移)
updateCommitstring-更新说明
rewardEnabledboolean-是否开启打赏激励
visibilitystring-可见范围(PUBLIC/PRIVATE)
isPaidboolean-是否付费资源
priceCurrencyCodestring-价格货币代码
priceAmountnumber-价格金额
isAllEditboolean-是否公开编辑
memberEnabledboolean-是否开启项目成员功能
isNewDraftboolean-是否为新建草稿(true=新建草稿,false/null=更新已有草稿)
parentPostIdint64-父帖子ID(编辑已发布帖子时传入原帖ID,用于创建EDIT类型草稿)
响应 ResponseDTOOpenApiPostIdVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiPostIdVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/mods/draft/init
初始化资源帖子草稿(代理用户场景;返回新建草稿 postId)
请求体 BaseOpenApiInitDraftParam
字段类型必填说明
sectionCodestring板块(游戏)code
resourceTypeIdint64-资源类型 ID(关联 resource_ext_info 表 type=RESOURCE_TYPE 行)
categoryIdstring-分类 ID(逗号分隔,最多 5 个;对应 resource_ext_info type=RESOURCE_MAIN_CATEGORY)
titlestring-标题(可选,未填时由用户在编辑页补全)
presetCategorystring-预设类目(存档广场聚合场景使用,如 SAVE_GAME / CHALLENGE_CONFIG / GRAPHICS_PRESET)
响应 ResponseDTOOpenApiPostIdVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiPostIdVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/{postId}/edit
编辑已发布资源帖子(强制审批;代理用户场景)
参数
名称位置必填说明
postIdpathLong
请求体 BaseOpenApiResourceSaveParam
字段类型必填说明
postIdint64-帖子ID(编辑时使用)
mainNamestring资源主名称
subNamestring-资源次名称
mainCategorystring-主要类别(支持多个,用逗号分隔,最多5个)
presetCategorystring-预设类目(SAVE_GAME/CHALLENGE_CONFIG/GRAPHICS_PRESET),可选;普通资源传 null
abbrNamestring-缩写名称
introductionstring-资源简介
coverFileIdstring-封面文件ID
mdContentstringMarkdown格式内容
contentstring-普通文本内容
sectionCodestring板块代码
gameTypeIdint64-游戏类型ID
resourceTypeIdint64资源类型ID
runPlatformIdint64-运行平台ID
contentCopyrightIdint64-内容版权ID
contentCopyrightstring-内容版权协议
resourceCopyrightIdint64-资源版权ID
resourceCopyrightstring-资源开源协议
resourceVersionstring-资源版本
authorsstring作者信息(JSON 数组字符串)
postTagsarray<string>-帖子标签列表
postTypeIdstring-资源帖子类型ID
clientEnvironmentstring客户端运行环境
serverEnvironmentstring服务端运行环境
resourceStatestring资源状态
sourceStatestring开源状态
relationResourceRelationParam--
installScriptstring-安装脚本
creationTypestring创作类型
refLinkstring-参考链接(JSON数组字符串)
resourceRelatearray<BaseOpenApiResourceRelateParam>-资源关联列表
resourceFileInfoVosarray<BaseOpenApiResourceFileInfoParam>-资源文件信息列表
imagesarray<string>-媒体图片文件ID列表
tempIdstring-临时ID(用于文件迁移)
updateCommitstring-更新说明
rewardEnabledboolean-是否开启打赏激励
visibilitystring-可见范围(PUBLIC/PRIVATE)
isPaidboolean-是否付费资源
priceCurrencyCodestring-价格货币代码
priceAmountnumber-价格金额
isAllEditboolean-是否公开编辑
memberEnabledboolean-是否开启项目成员功能
isNewDraftboolean-是否为新建草稿(true=新建草稿,false/null=更新已有草稿)
parentPostIdint64-父帖子ID(编辑已发布帖子时传入原帖ID,用于创建EDIT类型草稿)
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/draft/{draftId}/publish
从草稿发布资源帖子(含审批流转;代理用户场景)
参数
名称位置必填说明
draftIdpathLong
请求体 BaseOpenApiResourceSaveParam
字段类型必填说明
postIdint64-帖子ID(编辑时使用)
mainNamestring资源主名称
subNamestring-资源次名称
mainCategorystring-主要类别(支持多个,用逗号分隔,最多5个)
presetCategorystring-预设类目(SAVE_GAME/CHALLENGE_CONFIG/GRAPHICS_PRESET),可选;普通资源传 null
abbrNamestring-缩写名称
introductionstring-资源简介
coverFileIdstring-封面文件ID
mdContentstringMarkdown格式内容
contentstring-普通文本内容
sectionCodestring板块代码
gameTypeIdint64-游戏类型ID
resourceTypeIdint64资源类型ID
runPlatformIdint64-运行平台ID
contentCopyrightIdint64-内容版权ID
contentCopyrightstring-内容版权协议
resourceCopyrightIdint64-资源版权ID
resourceCopyrightstring-资源开源协议
resourceVersionstring-资源版本
authorsstring作者信息(JSON 数组字符串)
postTagsarray<string>-帖子标签列表
postTypeIdstring-资源帖子类型ID
clientEnvironmentstring客户端运行环境
serverEnvironmentstring服务端运行环境
resourceStatestring资源状态
sourceStatestring开源状态
relationResourceRelationParam--
installScriptstring-安装脚本
creationTypestring创作类型
refLinkstring-参考链接(JSON数组字符串)
resourceRelatearray<BaseOpenApiResourceRelateParam>-资源关联列表
resourceFileInfoVosarray<BaseOpenApiResourceFileInfoParam>-资源文件信息列表
imagesarray<string>-媒体图片文件ID列表
tempIdstring-临时ID(用于文件迁移)
updateCommitstring-更新说明
rewardEnabledboolean-是否开启打赏激励
visibilitystring-可见范围(PUBLIC/PRIVATE)
isPaidboolean-是否付费资源
priceCurrencyCodestring-价格货币代码
priceAmountnumber-价格金额
isAllEditboolean-是否公开编辑
memberEnabledboolean-是否开启项目成员功能
isNewDraftboolean-是否为新建草稿(true=新建草稿,false/null=更新已有草稿)
parentPostIdint64-父帖子ID(编辑已发布帖子时传入原帖ID,用于创建EDIT类型草稿)
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/draft/{draftId}/save
保存资源帖子草稿(draftId=0 表示新建草稿;代理用户场景)
参数
名称位置必填说明
draftIdpathLong
请求体 BaseOpenApiResourceSaveParam
字段类型必填说明
postIdint64-帖子ID(编辑时使用)
mainNamestring资源主名称
subNamestring-资源次名称
mainCategorystring-主要类别(支持多个,用逗号分隔,最多5个)
presetCategorystring-预设类目(SAVE_GAME/CHALLENGE_CONFIG/GRAPHICS_PRESET),可选;普通资源传 null
abbrNamestring-缩写名称
introductionstring-资源简介
coverFileIdstring-封面文件ID
mdContentstringMarkdown格式内容
contentstring-普通文本内容
sectionCodestring板块代码
gameTypeIdint64-游戏类型ID
resourceTypeIdint64资源类型ID
runPlatformIdint64-运行平台ID
contentCopyrightIdint64-内容版权ID
contentCopyrightstring-内容版权协议
resourceCopyrightIdint64-资源版权ID
resourceCopyrightstring-资源开源协议
resourceVersionstring-资源版本
authorsstring作者信息(JSON 数组字符串)
postTagsarray<string>-帖子标签列表
postTypeIdstring-资源帖子类型ID
clientEnvironmentstring客户端运行环境
serverEnvironmentstring服务端运行环境
resourceStatestring资源状态
sourceStatestring开源状态
relationResourceRelationParam--
installScriptstring-安装脚本
creationTypestring创作类型
refLinkstring-参考链接(JSON数组字符串)
resourceRelatearray<BaseOpenApiResourceRelateParam>-资源关联列表
resourceFileInfoVosarray<BaseOpenApiResourceFileInfoParam>-资源文件信息列表
imagesarray<string>-媒体图片文件ID列表
tempIdstring-临时ID(用于文件迁移)
updateCommitstring-更新说明
rewardEnabledboolean-是否开启打赏激励
visibilitystring-可见范围(PUBLIC/PRIVATE)
isPaidboolean-是否付费资源
priceCurrencyCodestring-价格货币代码
priceAmountnumber-价格金额
isAllEditboolean-是否公开编辑
memberEnabledboolean-是否开启项目成员功能
isNewDraftboolean-是否为新建草稿(true=新建草稿,false/null=更新已有草稿)
parentPostIdint64-父帖子ID(编辑已发布帖子时传入原帖ID,用于创建EDIT类型草稿)
响应 ResponseDTOOpenApiPostIdVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiPostIdVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/resource/init-draft
初始化资源帖子草稿(代理用户场景;返回新建草稿 postId)
请求体 BaseOpenApiInitDraftParam
字段类型必填说明
sectionCodestring板块(游戏)code
resourceTypeIdint64-资源类型 ID(关联 resource_ext_info 表 type=RESOURCE_TYPE 行)
categoryIdstring-分类 ID(逗号分隔,最多 5 个;对应 resource_ext_info type=RESOURCE_MAIN_CATEGORY)
titlestring-标题(可选,未填时由用户在编辑页补全)
presetCategorystring-预设类目(存档广场聚合场景使用,如 SAVE_GAME / CHALLENGE_CONFIG / GRAPHICS_PRESET)
响应 ResponseDTOOpenApiPostIdVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiPostIdVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiServerPostLobbyController (8)
POST/openapi/v2/server-post/lobby/{postId}/close
关闭联机帖 (软删主帖 + 资源行)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
GET/openapi/v2/server-post/lobby/{postId}/manifest
联机小子拉资源清单 (匿名可访问)
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOOpenApiServerPostLobbyManifestVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiServerPostLobbyManifestVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/server-post/lobby/{postId}/refresh-urls
批量刷新资源预签名 URL
参数
名称位置必填说明
postIdpathLong
响应 ResponseDTOInteger
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataint32-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/server-post/lobby/{postId}/resources/{resourceId}/cancel
用户自建资源占位取消 (PENDING 物删 / UPLOADED tombstone)
参数
名称位置必填说明
postIdpathLong
resourceIdpathLong
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/server-post/lobby/{postId}/resources/{resourceId}/upload
用户自建资源实际上传 (multipart + 流式 sha256 校验)
参数
名称位置必填说明
postIdpathLong
resourceIdpathLong
filequeryMultipartFile
响应 ResponseDTOOpenApiServerPostLobbyUploadResultVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiServerPostLobbyUploadResultVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/server-post/lobby/{postId}/resources/reserve-batch
用户自建资源批量占位 (sha256 全库去重 + uploadToken 下发)
参数
名称位置必填说明
postIdpathLong
请求体 BaseOpenApiServerPostLobbyReserveBatchParam
字段类型必填说明
itemsarray<BaseOpenApiServerPostLobbyReserveItemParam>待占位的资源清单 (单次最多 50 条)
响应 ResponseDTOOpenApiServerPostLobbyReserveBatchVo
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiServerPostLobbyReserveBatchVo--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/server-post/lobby/{postId}/update
更新联机帖 (覆盖字段 + 全量替换资源清单)
参数
名称位置必填说明
postIdpathLong
请求体 BaseOpenApiServerPostLobbyPublishParam
字段类型必填说明
postTitlestring-帖子标题
mainNamestring服务器名字
sectionCodestring板块 code
serverIpstring服务器 IP / 域名
serverPortint32-服务器端口
serverPasswordstring-联机加入密码
maxPlayersint32-最大玩家数
serverVersionarray<string>-服务器版本列表
mainPlayTypestring-主打类型
serverTypestring-服务器类型
runPlatformstring-运行平台
queryTypestring-查询协议
coverImageUrlstring-封面图 URL
mdContentstring-markdown 正文
onlineTypestring-联机类型
isReqDownClientboolean-是否需要下载客户端
resourcesarray<BaseOpenApiServerPostLobbyResourceItemParam>-资源清单
响应 ResponseDTOBoolean
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
databoolean-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
POST/openapi/v2/server-post/lobby/publish
联机帖一键公开 (代理用户创建 + 全量写入资源清单)
请求体 BaseOpenApiServerPostLobbyPublishParam
字段类型必填说明
postTitlestring-帖子标题
mainNamestring服务器名字
sectionCodestring板块 code
serverIpstring服务器 IP / 域名
serverPortint32-服务器端口
serverPasswordstring-联机加入密码
maxPlayersint32-最大玩家数
serverVersionarray<string>-服务器版本列表
mainPlayTypestring-主打类型
serverTypestring-服务器类型
runPlatformstring-运行平台
queryTypestring-查询协议
coverImageUrlstring-封面图 URL
mdContentstring-markdown 正文
onlineTypestring-联机类型
isReqDownClientboolean-是否需要下载客户端
resourcesarray<BaseOpenApiServerPostLobbyResourceItemParam>-资源清单
响应 ResponseDTOLong
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataint64-返回数据
dataTypeint32--
traceIdstring-追踪ID,用于日志串联
OpenApiSsoController (1)
POST/openapi/v2/sso/exchange
以 X-Proxy-Access-Token 换取 5 分钟一次性 SSO ticket(供浏览器无感登录 mzgf)
响应 ResponseDTOOpenApiSsoTicketVO
字段类型必填说明
codeint32-返回码
levelstring-级别
msgstring-返回消息
okboolean-是否成功
dataOpenApiSsoTicketVO--
dataTypeint32--
traceIdstring-追踪ID,用于日志串联