接口说明

读完本页应能知道:接消费端先打开哪份 YAML,后台改接口以哪份为准。

车库对外是 一套 Go API、两份契约、两个鉴权面

契约文件(仓库)给谁看
BaaS / Appdocs/openapi/baas-app-v1.yaml下游做 Web、H5、App 的第一入口
主契约docs/openapi/openapi.yamlAdmin 全量 + 已实现的 App 路径;零 stub

本站不复制字段级定义,也不硬编码路径总数——以仓库 YAML 为准。服务端不托管 Swagger UI。

Studio 自身 API 不受这两份契约管辖,见 AI 创作 · API。「成片导入 catalog」仍走主契约的 Admin 路径。

先读哪页

你要做的事
给 Web / H5 / App 接登录和内容BaaS 鉴权能力地图
看后台有哪些管理接口Admin 概览
搞清版本与合同测试契约与版本

路径前缀

前缀
/api/v1/admin/*运营后台
/api/v1/app/*/api/v1/events/*/api/v1/landing/*消费端
/api/v1/auth/*登录;Admin 与 App 各有端点
/api/v1/pay/notify/*支付渠道回调(服务间,不对 App 页面)
/healthz/readyz探活

C 端成功信封:{code:"OK", message, data, request_id}。Admin 成功业务字段平铺 + request_id。错误两边都带 code / message / request_id

多端同一套接口

Web、H5、以及打同一套 BaaS 的 App(心跳榜的 Capacitor 壳、上头短剧目标中的 Flutter)调用同一路径。可选头 X-Client-Platform: web | android | ios 只做提示,不改变订单与权益事实。