Die Referenzseiten in den Open Cloud v2 und Open Cloud v1 Abschnitten werden aus JSON-Dateien gerendert, die OpenAPI-Beschreibungen sind.Diese Dateien verwenden die Version 3.0.4 der OpenAPI-Spezifikation.
Diese Dateien sind Open Source und können mit Tools wie dem Swagger-Editor und Postman zur Testung von API-Aufrufen und zur Optimierung der Entwicklung verwendet werden.
Diese OpenAPI-Beschreibungen sind noch in aktiver Entwicklung und können Probleme enthalten.Die Seiten unter der Ressourcen -Sektion sind die offizielle Referenz.
OpenAPI-Beschreibungsdateien
OpenAPI-Beschreibungsdateien sind an den folgenden Orten innerhalb des Creator-Dokumenten-Repositories verfügbar:
Verkäufer-Erweiterungen
Roblox verwendet Spezifikations-Erweiterungen, um die OpenAPI-Spezifikation zu erweitern.Diese Erweiterungen repräsentieren Informationen, die die Spezifikation standardmäßig nicht erfasst.Erweiterungen können während des gesamten Dokuments erscheinen, sofern dies durch die OpenAPI-Spezifikation erlaubt wird.
Die Mehrheit dieser Spezifikations-Erweiterungen ist experimentell.Die verwendeten Erweiterungen können ohne Benachrichtigung geändert werden, zugunsten von Feldern, die innerhalb der offiziellen OpenAPI-Spezifikation gefunden werden.
Die OpenAPI-Beschreibungen für Ressourcen der V1- und V2-Klasse nutzen unterschiedliche Spezifikationsausdehnungen aufgrund von implementierungsbedingten Unterschieden.
Ressourcenspezifikations-Erweiterungen V2
| Erweiterung | Ort | Beschreibung |
|---|---|---|
| x-categories | OpenAPI-Objekt | Liste von Zeichenketten.Alle Ressourcenkategorien. |
| x-visibility | Betriebsobjekt | Boolean.Die Sichtbarkeit der Operation. |
| x-roblox-docs | Betriebsobjekt | Objekt.Verbindet eine Operation mit einer Kategorie und Ressource. |
| x-long-running-operation-parameters | Betriebsobjekt | Objekt.Verweist auf die Metadaten und die Antwort für die lange Laufzeitantwort der Operation. |
| x-aep-resource | Schema-Objekt | Objekt.Eine Erweiterung, die den eingebenannotiert.Hat eine enge Kompatibilität zu AEP-4, einer der API-Verbesserungsvorschläge. |
| x-oneOf | Schema-Objekt | Objekt.Jedes Feld enthält eine Liste von Eigenschaften im Schema.Nur eine der Eigenschaften sollte vorhanden sein. |
| x-resource | Schema-Objekt | Boolean.Ob das Schema eine Ressource ist. |
| x-immutable | Schema-Objekt | Boolean.Ob das Schema unveränderlich ist. |
Ressourcenspezifikations-Erweiterungen V1
| Erweiterung | Ort | Beschreibung |
|---|---|---|
| x-roblox-cloud-api-operation | Betriebsobjekt | Boolean.Ob die Operation eine Open-Cloud-Operation ist. |
| x-roblox-cloud-api-operation-name | Betriebsobjekt | String.Der Name der Operation. |
| x-roblox-cloud-api-operation-code-samples | Betriebsobjekt | Objekt.Eine Liste von Code-Beispielen, ein Objekt mit der Sprache/Titel und dem entsprechenden Skript, das. PL: die Skripts. |
| x-roblox-cloud-api-operation-throttling-limit | Betriebsobjekt | Objekt.Die Beschränkungen der Drosselung für die Operation. |