Roblox publie un document OpenAPI 3.0.4 (anciennement connu sous le nom de fichier Swagger) qui contient toutes les API Cloud de Roblox. Vous pouvez trouver ce fichier, openapi.json, dans le dépôt open source creator-docs.
Vous pouvez utiliser des documents OpenAPI avec des outils comme Swagger Editor et Postman pour tester les appels et aider à rationaliser le développement. Des outils comme OpenAPI Generator peuvent également générer des bibliothèques clientes pour vos langages de programmation préférés.
Ce document est encore en cours de développement actif et peut contenir des problèmes. Signalez un bug si vous remarquez des informations inexactes.
Extensions du fournisseur
Roblox utilise des extensions de spécification pour étendre la spécification OpenAPI. Ces extensions représentent des informations que la spécification ne capture pas par défaut. Les extensions peuvent apparaître tout au long du fichier là où cela est autorisé par la spécification OpenAPI.
La majorité de ces extensions de spécification sont expérimentales. Les extensions utilisées sont susceptibles de changer sans préavis en faveur de champs trouvés dans la spécification OpenAPI officielle.
| Extension | Emplacement | Description |
|---|---|---|
| x-roblox-extensions-version | Objet OpenAPI | Une chaîne de version, utilisant la gestion sémantique des versions, qui représente les versions des extensions spécifiées ici et d'autres structures communes |
| x-roblox-stability | Objet d'opération | Une chaîne qui représente le niveau de stabilité d'une opération. |
| x-roblox-deprecated | Objet d'opération | Un objet qui fournit des informations supplémentaires liées au statut de dépréciation d'un point de terminaison. |
| x-roblox-alternatives | Objet d'opération | Un objet qui fournit des informations supplémentaires liées aux alternatives d'un point de terminaison. |
| x-roblox-rate-limits | Objet d'opération | Un objet qui fournit des informations sur la limitation de taux pour un point de terminaison. |
| x-roblox-scopes | Objet d'opération | Un objet qui fournit la liste des portées requises, conditionnelles et optionnelles qui sont associées à un point de terminaison. |
| x-roblox-engine-usability | Objet d'opération | Un objet indiquant l'utilisabilité du point de terminaison avec le moteur Roblox. |