Roblox veröffentlicht ein OpenAPI 3.0.4-Dokument (früher bekannt als Swagger-Datei), das alle Roblox Cloud APIs enthält. Diese Datei, openapi.json, finden Sie im Open-Source-creator-docs-Repository.
Sie können OpenAPI-Dokumente mit Tools wie dem Swagger Editor und Postman verwenden, um Anfragen zu testen und die Entwicklung zu erleichtern. Tools wie OpenAPI Generator können auch Client-Bibliotheken für Ihre bevorzugten Programmiersprachen generieren.
Dieses Dokument befindet sich noch in aktiver Entwicklung und kann Probleme enthalten. Melden Sie einen Fehler, wenn Sie ungenaue Informationen feststellen.
Vendor-Erweiterungen
Roblox verwendet Spezifikationserweiterungen, um die OpenAPI-Spezifikation zu erweitern. Diese Erweiterungen stellen Informationen dar, die von der Spezifikation standardmäßig nicht erfasst werden. Erweiterungen können an verschiedenen Stellen in der Datei erscheinen, wo es die OpenAPI-Spezifikation erlaubt.
Die Mehrheit dieser Spezifikationserweiterungen ist experimentell. Die verwendeten Erweiterungen können ohne vorherige Ankündigung geändert werden zugunsten von Feldern, die in der offiziellen OpenAPI-Spezifikation zu finden sind.
| Erweiterung | Standort | Beschreibung |
|---|---|---|
| x-roblox-extensions-version | OpenAPI-Objekt | Eine Versionszeichenfolge, die semantic versioning verwendet und die Versionen der hier angegebenen Erweiterungen und anderer gängiger Strukturen darstellt |
| x-roblox-stability | Operationsobjekt | Eine Zeichenfolge, die das Stabilitätsniveau einer Operation darstellt. |
| x-roblox-deprecated | Operationsobjekt | Ein Objekt, das zusätzliche Informationen zum Deaktivierungsstatus eines Endpunkts liefert. |
| x-roblox-alternatives | Operationsobjekt | Ein Objekt, das zusätzliche Informationen zu den Alternativen eines Endpunkts liefert. |
| x-roblox-rate-limits | Operationsobjekt | Ein Objekt, das Informationen zur Ratenbegrenzung für einen Endpunkt bereitstellt. |
| x-roblox-scopes | Operationsobjekt | Ein Objekt, das die Liste der erforderlichen, bedingten und optionalen Bereiche liefert, die mit einem Endpunkt verbunden sind. |
| x-roblox-engine-usability | Operationsobjekt | Ein Objekt, das die Benutzerfreundlichkeit des Endpunkts mit der Roblox-Engine angibt. |