Roblox 发布了一个 OpenAPI 3.0.4 文档（以前称为 Swagger 文件），该文档包含 所有 Roblox Cloud APIs。您可以在开源 creator-docs 存储库中找到这个文件 openapi.json。
您可以使用 OpenAPI 文档配合 Swagger 编辑器 和 Postman 工具测试调用，帮助简化开发。像 OpenAPI 生成器 这样的工具还可以为您选择的编程语言生成客户端库。
本文件仍在积极开发中，可能包含问题。如果您发现不准确的信息，请报告错误。
供应商扩展
Roblox 使用 规范扩展 来扩展 OpenAPI 规范。这些扩展代表了规范默认未捕获的信息。扩展可能会在文件中任意允许的地方出现。
这些规范扩展的大多数是实验性的。所使用的扩展可能会在没有通知的情况下进行更改，以支持官方 OpenAPI 规范中找到的字段。
| 扩展 | 位置 | 描述 |
|---|---|---|
| x-roblox-extensions-version | OpenAPI 对象 | 一个版本字符串，使用语义化版本控制，表示此处指定的扩展和其他常见结构的版本 |
| x-roblox-stability | 操作对象 | 一个表示操作稳定性级别的字符串。 |
| x-roblox-deprecated | 操作对象 | 一个对象，提供与端点的弃用状态相关的附加信息。 |
| x-roblox-alternatives | 操作对象 | 一个对象，提供与端点替代方案相关的附加信息。 |
| x-roblox-rate-limits | 操作对象 | 一个对象，提供有关端点的速率限制信息。 |
| x-roblox-scopes | 操作对象 | 一个对象，提供与端点相关的必需、条件和可选范围的列表。 |
| x-roblox-engine-usability | 操作对象 | 一个对象，指示端点与 Roblox 引擎的可用性。 |