Roblox 發佈了一個 OpenAPI 3.0.4 文件(前身為 Swagger 文件),該文件包含了 所有 的 Roblox Cloud API。您可以在開源的 creator-docs 倉庫中找到這個文件,openapi.json。
您可以使用 OpenAPI 文件與像是 Swagger Editor 和 Postman 這樣的工具來測試調用並幫助簡化開發。像是 OpenAPI Generator 這樣的工具也可以為您首選的程式語言生成客戶端庫。
供應商擴展
Roblox 使用 規範擴展 來擴展 OpenAPI 規範。這些擴展代表了規範默認未捕獲的信息。擴展可能會出現在文件中 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 引擎中的可用性的物件。 |