Roblox publica um documento OpenAPI 3.0.4 (anteriormente conhecido como arquivo Swagger) que contém todas as APIs da Roblox Cloud. Você pode encontrar este arquivo, openapi.json, no repositório de código aberto creator-docs.
Você pode usar documentos OpenAPI com ferramentas como o Swagger Editor e Postman para testar chamadas e ajudar a agilizar o desenvolvimento. Ferramentas como OpenAPI Generator também podem gerar bibliotecas de cliente para suas linguagens de programação preferidas.
Este documento ainda está em desenvolvimento ativo e pode conter problemas. Relate um bug se você notar informações imprecisas.
Extensões de fornecedor
Roblox usa extensões de especificação para estender a especificação OpenAPI. Essas extensões representam informações que a especificação não captura por padrão. As extensões podem aparecer ao longo do arquivo onde permitido pela especificação OpenAPI.
A maioria dessas extensões de especificação são experimentais. As extensões utilizadas estão sujeitas a mudanças sem aviso prévio em favor de campos encontrados dentro da especificação OpenAPI oficial.
| Extensão | Localização | Descrição |
|---|---|---|
| x-roblox-extensions-version | Objeto OpenAPI | Uma string de versão, usando versionamento semântico, que representa as versões das extensões especificadas aqui e outras estruturas comuns |
| x-roblox-stability | Objeto de operação | Uma string que representa o nível de estabilidade de uma operação. |
| x-roblox-deprecated | Objeto de operação | Um objeto que fornece informações adicionais relacionadas ao status de obsolescência de um endpoint. |
| x-roblox-alternatives | Objeto de operação | Um objeto que fornece informações adicionais relacionadas às alternativas de um endpoint. |
| x-roblox-rate-limits | Objeto de operação | Um objeto que fornece informações de limite de taxa para um endpoint. |
| x-roblox-scopes | Objeto de operação | Um objeto que fornece a lista de escopos obrigatórios, condicionais e opcionais associados a um endpoint. |
| x-roblox-engine-usability | Objeto de operação | Um objeto que indica a usabilidade do endpoint com o motor Roblox. |