Các trang tham khảo trong phần Mở đám mây v2 và Mở đám mây v1 được hiển thị từ các tập tin JSON là Mô tả OpenAPI .Các tập tin này sử dụng phiên bản 3.0.4 của đặcification OpenAPI.
Các tập tin này là mã nguồn mở và có thể được sử dụng với các công cụ như Trình biên tập Swagger và Postman để kiểm tra các cuộc gọi API và giúp tối ưu hóa phát triển.
Các mô tả OpenAPI này vẫn đang trong giai đoạn phát triển và có thể có vấn đề.Các trang dưới phần Tài nguyên là tham chiếu chính thức.
Tập tin mô tả OpenAPI
Các tập tin mô tả OpenAPI có sẵn tại các vị trí sau trong kho lưu trữ creator-docs:
# All V2 Resourceshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json# V1 Assetshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json# V1 Ordered Data Storeshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json# V1 Standard Data Storeshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json# V1 Messaginghttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json# V1 Universeshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json
Mở rộng nhà cung cấp
Roblox sử dụng mở rộng specification để mở rộng specification OpenAPI.Các mở rộng này đại diện cho thông tin mà thông số kỹ thuật không thu thập mặc định.Các tiện ích có thể xuất hiện trên toàn bộ tập tin nếu được phép bởi thông số OpenAPI.
Phần lớn các mở rộng thông số này là thử nghiệm.Các mở rộng được sử dụng phải thay đổi mà không có thông báo để ủng hộ các trường được tìm thấy trong bản thông số OpenAPI chính thức.
Mở rộng thông số tài nguyên V2
Mở rộng | Vị trí | Mô tả |
---|---|---|
x-categories | Đối tượng OpenAPI | Danh sách các chuỗi.Tất cả các danh mục tài nguyên. |
x-visibility | Đối tượng hoạt động | Boolean.Tầm nhìn của hoạt động. |
x-roblox-docs | Đối tượng hoạt động | Đối tượng.Gán một hoạt động với một danh mục và tài nguyên. |
x-long-running-operation-parameters | Đối tượng hoạt động | Đối tượng.Tham chiếu vào metadata và response cho phản hồi dài chạy của hoạt động. |
x-aep-resource | Đối tượng Schema | Object.Một phần mở rộng ghi chú đánh máytài nguyên.Có sự tương thích gần với AEP-4 , một trong những đề xuất nâng cấp API . |
x-oneOf | Đối tượng Schema | Object.Mỗi trường bao gồm một danh sách các thuộc tính trong sơ đồ.Chỉ một trong những thuộc tính nên có mặt. |
x-resource | Đối tượng Schema | Boolean.Liệu cấu trúc có phải là một tài nguyên không. |
x-immutable | Đối tượng Schema | Boolean.Liệu cấu trúc có bất biến không. |
Mở rộng thông số tài nguyên V1
Mở rộng | Vị trí | Mô tả |
---|---|---|
x-roblox-cloud-api-operation | Đối tượng hoạt động | Boolean.Whether hoạt động là một hoạt động Open Cloud. |
x-roblox-cloud-api-operation-name | Đối tượng hoạt động | Chuỗi.Tên của hoạt động. |
x-roblox-cloud-api-operation-code-samples | Đối tượng hoạt động | Object.Một danh sách các mẫu mã code, một đối tượng với ngôn ngữ/tiêu đề và kịch bản tương ứng. |
x-roblox-cloud-api-operation-throttling-limit | Đối tượng hoạt động | Object.Giới hạn giảm tốc cho hoạt động. |