跳到主要内容
开发者文档
文档目录

API 参考

Markdown 版

这份参考由 OpenAPI 规格生成。标“即将上线”的接口还不存在,不是稳定契约,上线前可能调整。标“需要部署开启”的接口属于部署可选功能,未开启的部署上返回 404。

Base URLhttps://api.mirabase.dev
OpenAPIhttps://api.mirabase.dev/v2/openapi.yaml
规格版本2.0.0 (33c172f77f2c)
状态115 个已实现(默认部署),12 个已实现(部署可选),3 个即将上线

通用请求头

所有接口都接受下面的请求头。通过认证的响应都带 RateLimit-Limit、RateLimit-Remaining 和 RateLimit-Reset,见 限流与限额。分页、幂等、条件请求、任务和错误的规则见 API 约定,全部错误码见 错误码。

字段类型说明
Mirabase-Contract-Versionstring要协商的契约版本。不传时使用当前兼容的契约。
X-Request-Idstring调用方关联 id;取值无效时替换为服务端签发的 id。

接口分组