Roblox publikuje dokument OpenAPI 3.0.4 (wcześniej znany jako plik Swagger), który zawiera wszystkie interfejsy API Roblox Cloud. Możesz znaleźć ten plik, openapi.json, w otwartym repozytorium creator-docs.
Możesz używać dokumentów OpenAPI z narzędziami takimi jak Swagger Editor i Postman, aby testować wywołania i pomóc w usprawnieniu rozwoju. Narzędzia takie jak OpenAPI Generator mogą również generować biblioteki klienckie dla preferowanych języków programowania.
Ten dokument jest nadal w aktywnym opracowaniu i może zawierać problemy. Zgłoś błąd, jeśli zauważysz nieprawidłowe informacje.
Rozszerzenia dostawcy
Roblox używa rozszerzeń specyfikacji, aby rozszerzyć specyfikację OpenAPI. Te rozszerzenia reprezentują informacje, które specyfikacja nie uwzględnia domyślnie. Rozszerzenia mogą pojawiać się w całym pliku, gdzie zezwala na to specyfikacja OpenAPI.
Większość tych rozszerzeń specyfikacji jest eksperymentalna. Używane rozszerzenia mogą ulegać zmianom bez powiadomienia na rzecz pól znajdujących się w oficjalnej specyfikacji OpenAPI.
| Rozszerzenie | Lokalizacja | Opis |
|---|---|---|
| x-roblox-extensions-version | Obiekt OpenAPI | Łańcuch wersji, używający semantycznego wersjonowania, który reprezentuje wersje rozszerzeń określonych tutaj oraz innych wspólnych struktur |
| x-roblox-stability | Obiekt operacji | Łańcuch, który reprezentuje poziom stabilności operacji. |
| x-roblox-deprecated | Obiekt operacji | Obiekt, który dostarcza dodatkowych informacji związanych z statusem deprecacji punktu końcowego. |
| x-roblox-alternatives | Obiekt operacji | Obiekt, który dostarcza dodatkowych informacji związanych z alternatywami danego punktu końcowego. |
| x-roblox-rate-limits | Obiekt operacji | Obiekt, który dostarcza informacji o ograniczeniach liczby wywołań dla danego punktu końcowego. |
| x-roblox-scopes | Obiekt operacji | Obiekt, który dostarcza listę wymaganych, warunkowych i opcjonalnych zakresów związanych z danym punktem końcowym. |
| x-roblox-engine-usability | Obiekt operacji | Obiekt wskazujący na użyteczność punktu końcowego z silnikiem Roblox. |