Roblox xuất bản một tài liệu OpenAPI 3.0.4 (trước đây được gọi là tệp Swagger) chứa tất cả các API của Roblox Cloud. Bạn có thể tìm thấy tệp này, openapi.json, trong kho mã nguồn mở creator-docs.
Bạn có thể sử dụng các tài liệu OpenAPI với các công cụ như Swagger Editor và Postman để kiểm tra các cuộc gọi và giúp tăng tốc phát triển. Các công cụ như OpenAPI Generator cũng có thể tạo ra các thư viện khách cho các ngôn ngữ lập trình mà bạn ưa thích.
Tài liệu này vẫn đang trong quá trình phát triển tích cực và có thể chứa những vấn đề. Hãy báo cáo lỗi nếu bạn thấy thông tin không chính xác.
Mở rộng nhà cung cấp
Roblox sử dụng các mở rộng của đặc tả để mở rộng đặc tả OpenAPI. Những mở rộng này đại diện cho thông tin mà đặc tả không ghi lại theo mặc định. Các mở rộng có thể xuất hiện trong toàn bộ tệp nơi mà đặc tả OpenAPI cho phép.
Phần lớn các mở rộng đặc tả này là thử nghiệm. Các mở rộng sử dụng có thể thay đổi mà không cần thông báo trước để ưu tiên cho các trường có trong đặc tả OpenAPI chính thức.
| Mở rộng | Vị trí | Mô tả |
|---|---|---|
| x-roblox-extensions-version | Đối tượng OpenAPI | Một chuỗi phiên bản, sử dụng quản lý phiên bản ngữ nghĩa, đại diện cho các phiên bản của các mở rộng được chỉ định ở đây và các cấu trúc thông thường khác |
| x-roblox-stability | Đối tượng Operation | Một chuỗi đại diện cho cấp độ ổn định của một thao tác. |
| x-roblox-deprecated | Đối tượng Operation | Một đối tượng cung cấp thông tin bổ sung liên quan đến trạng thái ngừng sử dụng của một điểm cuối. |
| x-roblox-alternatives | Đối tượng Operation | Một đối tượng cung cấp thông tin bổ sung liên quan đến các lựa chọn thay thế của một điểm cuối. |
| x-roblox-rate-limits | Đối tượng Operation | Một đối tượng cung cấp thông tin giới hạn tần suất cho một điểm cuối. |
| x-roblox-scopes | Đối tượng Operation | Một đối tượng cung cấp danh sách các phạm vi cần thiết, có điều kiện và tùy chọn liên quan đến một điểm cuối. |
| x-roblox-engine-usability | Đối tượng Operation | Một đối tượng cho biết khả năng sử dụng của điểm cuối với engine của Roblox. |