開放API說明

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

在 開啟雲端 v2 和 開啟雲端 v1 部分的參考頁面是從 OpenAPI 說明 JSON 檔案渲染的。這些檔案使用 版本 3.0.4 的開放 API 規格。

這些檔案是開源的，可以使用像是 Swagger 編輯器 和 Postman 等工具來測試 API 呼叫並幫助簡化開發。

這些開放 API 說明仍在進行中，可能包含問題。資源 部分 下的頁面是官方參考。

開啟 API 說明檔案

開放 API 說明檔案可在以下位置存取 創作者文件夾 存儲庫中：

# All V2 Resources

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json



# V1 Assets

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json



# V1 Ordered Data Stores

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json



# V1 Standard Data Stores

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json



# V1 Messaging

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json



# V1 Universes

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json

供應商擴展

Roblox 使用 規格擴展 來擴展開放 API 規格。這些擴展代表規格沒有預設捕捉的資訊。擴展可能出現在開放 API 規格允許的文件中。

這些規格擴展的大多數是實驗性的。使用的擴展程式可能會在沒有通知的情況下更改，以支持官方 OpenAPI 規格中找到的欄位。

V2 資源規格擴展

擴展位置說明
x-categories開放 API 對象列表的字串。所有資源類別。
x-visibility操作對象Boolean。操作的可見度。
x-roblox-docs操作對象對象。將操作與類別和資源聯繫。
x-long-running-operation-parameters操作對象對象。參考操作的長時間回應的元數據和回應。
x-aep-resource計畫對象對象。一個附加標記資源類輸入的擴展。具有與 AEP-4 相近的兼容性，是 API 增強提案 之一。
x-oneOf模型對象對象。每個欄位包含在 schema 中的一個列表屬性。只有一個屬性應該存在。
x-resource計畫對象Boolean。是否資料庫是資源。
x-immutable計畫對象Boolean。是否使用不可變更的模型。

V1 資源規格擴展

擴展位置說明
x-roblox-cloud-api-operation操作對象Boolean。操作是否是開放雲端操作。
x-roblox-cloud-api-operation-name操作對象字串。操作的名稱。
x-roblox-cloud-api-operation-code-samples操作對象對象。一個代碼樣本列表、一個具有語指令碼/標題和對應的腳本的對象。
x-roblox-cloud-api-operation-throttling-limit操作對象對象。操作的限速限制。