OpenAPI 文件

*此內容是使用 AI(Beta 測試版)翻譯,可能含有錯誤。若要以英文檢視此頁面,請按一下這裡

Roblox 發佈了一個 OpenAPI 3.0.4 文件(以前稱為 Swagger 文件),其中包含 所有 的 Roblox Cloud APIs。您可以在開源的 creator-docs 存儲庫中找到此文件 openapi.json

您可以使用 OpenAPI 文件與如 Swagger 編輯器Postman 等工具進行測試呼叫,以幫助簡化開發過程。像 OpenAPI Generator 這樣的工具也可以為您首選的編程語言生成客戶端庫。


供應商擴展

Roblox 使用 規範擴展 來擴展 OpenAPI 規範。這些擴展代表了規範默認情況下未捕獲的信息。擴展可能在文件中出現,其中 OpenAPI 規範允許使用。

這些規範擴展中的大多數是實驗性質。使用的擴展可能會隨時更改,以便遵守官方 OpenAPI 規範中的字段。

擴展名稱位置描述
x-roblox-extensions-versionOpenAPI 對象一個版本字符串,使用語義版本控制,表示此處指定的擴展及其他常見結構的版本
x-roblox-stability操作對象一個字符串,表示操作的穩定性級別。
x-roblox-deprecated操作對象一個對象,提供與端點的棄用狀態相關的附加信息。
x-roblox-alternatives操作對象一個對象,提供與端點的替代方案相關的附加信息。
x-roblox-rate-limits操作對象一個對象,提供與端點的速率限制相關的信息。
x-roblox-scopes操作對象一個對象,提供與端點相關的所需、條件和可選範疇的列表。
x-roblox-engine-usability操作對象一個對象,指示該端點在 Roblox 引擎中的可用性。
©2026 Roblox Corporation、Roblox、Roblox 標誌及 Powering Imagination 是我們在美國及其他國家地區的部分註冊與未註冊商標。