OpenAPI 规范
采用 OpenAPI 3.1 格式、可供机器读取的 Warmbly API 说明。
Warmbly 的完整 API 由一份机器可读的 OpenAPI 3.1 文档描述：
https://docs.warmbly.com/openapi.json本参考文档的所有内容均根据该规范所描述的同一组接口生成，因此规范与文档始终保持一致。
可实现的用途
- 生成客户端。 将任意 OpenAPI 生成器（openapi-generator、oapi-codegen、openapi-typescript 等）指向此 URL，即可生成所用语言的强类型客户端。
- 交互式探索。 将此 URL 导入 Postman 或 Insomnia，即可获得可直接调用的集合，包含所有端点、参数和数据结构。
- 依据规范进行验证。 使用该规范进行契约测试，以便集成所依赖的假设发生变化时，测试能够明确报错。
目前提供 JavaScript 和 TypeScript、Python 及 Go 官方库（参阅 SDK）。对于其他语言，支持的接入方式是根据此规范生成客户端，或直接通过 HTTP 调用 API。
实时 WebSocket 网关提供独立的 AsyncAPI 3.1 机器可读描述；请参阅实时通信指南。
规范内置的约定
- 规范中仅定义了一个服务器：
https://api.warmbly.com/v1。其中所有路径均相对于这个包含版本号的基础 URL。请参阅版本管理。 - 身份验证采用以 Bearer 令牌传入的 API 密钥（
bearerAuth）。请参阅身份验证。 - 列表端点统一使用
data与pagination响应封装，以及不透明的cursor令牌；错误统一使用code与request_id结构。请参阅概述和错误码。
规范随 API 一同进行版本管理：破坏兼容性的变更会以新版本下的新规范发布，绝不会直接修改现有 v1 规范。