Roblox publiceert een OpenAPI 3.0.4-document (voorheen bekend als een Swagger-bestand) dat alle Roblox Cloud API's bevat. Je kunt dit bestand, openapi.json, vinden in de open source creator-docs repository.
Je kunt OpenAPI-documenten gebruiken met tools zoals de Swagger Editor en Postman om oproepen te testen en de ontwikkeling te stroomlijnen. Tools zoals OpenAPI Generator kunnen ook clientbibliotheken genereren voor jouw voorkeursprogrammeertalen.
Dit document is nog in actieve ontwikkeling en kan problemen bevatten. Meld een bug als je onnauwkeurige informatie opmerkt.
Leverancier extensies
Roblox gebruikt specificatie-extensies om de OpenAPI-specificatie uit te breiden. Deze extensies vertegenwoordigen informatie die de specificatie standaard niet vastlegt. Extensies kunnen door het bestand heen verschijnen waar dit door de OpenAPI-specificatie is toegestaan.
De meeste van deze specificatie-extensies zijn experimenteel. De gebruikte extensies kunnen zonder voorafgaande kennisgeving veranderen ten gunste van velden die in de officiële OpenAPI-specificatie zijn te vinden.
| Extensie | Locatie | Beschrijving |
|---|---|---|
| x-roblox-extensions-version | OpenAPI-object | Een versie-string, gebruikmakend van semantische versiebeheer, die de versies van de hier gespecificeerde extensies en andere veelvoorkomende structuren vertegenwoordigt |
| x-roblox-stability | Operatie-object | Een string die het stabiliteitsniveau van een operatie vertegenwoordigt. |
| x-roblox-deprecated | Operatie-object | Een object dat aanvullende informatie biedt met betrekking tot de deprecatiestatus van een eindpunt. |
| x-roblox-alternatives | Operatie-object | Een object dat aanvullende informatie biedt met betrekking tot de alternatieven van een eindpunt. |
| x-roblox-rate-limits | Operatie-object | Een object dat informatie over snelheidslimieten voor een eindpunt biedt. |
| x-roblox-scopes | Operatie-object | Een object dat de lijst van vereiste, voorwaardelijke en optionele scopes biedt die aan een eindpunt zijn gekoppeld. |
| x-roblox-engine-usability | Operatie-object | Een object dat de bruikbaarheid van het eindpunt met de Roblox-engine aangeeft. |