Roblox publica un documento OpenAPI 3.0.4 (anteriormente conocido como archivo Swagger) que contiene todas las API de Roblox Cloud. Puedes encontrar este archivo, openapi.json, en el repositorio de código abierto creator-docs.
Puedes usar documentos OpenAPI con herramientas como el Swagger Editor y Postman para probar las llamadas y ayudar a agilizar el desarrollo. Herramientas como OpenAPI Generator también pueden generar bibliotecas de cliente para tus lenguajes de programación preferidos.
Este documento sigue en desarrollo activo y puede contener problemas. Reporta un error si notas información inexacta.
Extensiones del proveedor
Roblox utiliza extensiones de especificación para ampliar la especificación OpenAPI. Estas extensiones representan información que la especificación no captura por defecto. Las extensiones pueden aparecer en todo el archivo donde lo permite la especificación OpenAPI.
La mayoría de estas extensiones de especificación son experimentales. Las extensiones utilizadas están sujetas a cambios sin previo aviso en favor de campos encontrados dentro de la especificación OpenAPI oficial.
| Extensión | Ubicación | Descripción |
|---|---|---|
| x-roblox-extensions-version | Objeto OpenAPI | Una cadena de versión, utilizando versionado semántico, que representa las versiones de las extensiones especificadas aquí y otras estructuras comunes |
| x-roblox-stability | Objeto de operación | Una cadena que representa el nivel de estabilidad de una operación. |
| x-roblox-deprecated | Objeto de operación | Un objeto que proporciona información adicional relacionada con el estado de deprecación de un endpoint. |
| x-roblox-alternatives | Objeto de operación | Un objeto que proporciona información adicional relacionada con las alternativas de un endpoint. |
| x-roblox-rate-limits | Objeto de operación | Un objeto que proporciona información sobre los límites de tasa para un endpoint. |
| x-roblox-scopes | Objeto de operación | Un objeto que proporciona la lista de alcances requeridos, condicionales y opcionales que están asociados con un endpoint. |
| x-roblox-engine-usability | Objeto de operación | Un objeto que indica la usabilidad del endpoint con el motor de Roblox. |