Les pages de référence dans les sections Open Cloud v2 et Open Cloud v1 sont rendues à partir de fichiers JSON qui sont des descriptions OpenAPI.Ces fichiers utilisent la version 3.0.4 de la spécification OpenAPI.
Ces fichiers sont source ouverte et peuvent être utilisés avec des outils comme le Swagger Editor et Postman pour tester les appels d'API et aider à rationaliser le développement.
Ces descriptions OpenAPI sont toujours en cours de développement actif et peuvent contenir des problèmes.Les pages de la section ressources sont la référence officielle.
Fichiers de description OpenAPI
Les fichiers de description de l'OpenAPI sont disponibles aux emplacements suivants dans le référentiel createur-docs :
Extensions de vendeur
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 où elles sont autorisées par la spécification OpenAPI.
La majorité de ces extensions de spécification sont expérimentales.Les extensions utilisées sont soumises à changement sans préavis en faveur des champs trouvés dans la spécification OpenAPI officielle.
Les descriptions OpenAPI pour les ressources V1 et V2 utilisent des extensions de spécification distinctes en raison des différences d'implémentation sous-jacentes.
Extensions de spécification de ressources V2
| Extension | Lieu | Description |
|---|---|---|
| x-categories | Objet OpenAPI Liste de chaînes.Toutes les catégories de ressources. | |
| x-visibility | Objet d'opération | Boolean.La visibilité de l'opération. |
| x-roblox-docs | Objet d'opération | Objet.Associe une opération à une catégorie et une ressource. |
| x-long-running-operation-parameters | Objet d'opération | Objet.Fait référence aux métadonnées et à la réponse pour la réponse longue de l'opération. |
| x-aep-resource | Objet de schéma | Objet.Une extension annotant le taperde ressource.A une compatibilité étroite avec AEP-4, l'une des propositions d'amélioration de l'API. |
| x-oneOf | Objet de schéma | Objet.Chaque champ contient une liste de propriétés dans le schéma.Seule une des propriétés devrait être présente. |
| x-resource | Objet de schéma | Boolean.Si le schéma est une ressource. |
| x-immutable | Objet de schéma | Boolean.Si le schéma est immuable. |
Extensions de spécification de ressources V1
| Extension | Lieu | Description |
|---|---|---|
| x-roblox-cloud-api-operation | Objet d'opération | Boolean.Si l'opération est une opération Open Cloud. |
| x-roblox-cloud-api-operation-name | Objet d'opération | String.Le nom de l'opération. |
| x-roblox-cloud-api-operation-code-samples | Objet d'opération | Objet.Une liste d'échantillons de code, un objet avec la langue/le titre et le script correspondant. |
| x-roblox-cloud-api-operation-throttling-limit | Objet d'opération | Object.Les limites de restriction pour l'opération. |