Descrições da OpenAPI

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

As páginas de referência nas seções Open Cloud v2 e Open Cloud v1 são renderizadas a partir de arquivos JSON que são descrições da API aberta.Estes arquivos usam a versão 3.0.4 da especificação OpenAPI.

Estes arquivos são de código aberto e podem ser usados com ferramentas como o Editor Swagger e o Postman para testar chamadas de API e ajudar a simplificar o desenvolvimento.

Essas descrições da OpenAPI ainda estão em desenvolvimento ativo e podem conter problemas.As páginas sob a seção Recursos são a referência oficial.

Arquivos de descrição da OpenAPI

Os arquivos de descrição da OpenAPI estão disponíveis nos seguintes locais dentro do repositório creator-docs:

# All V2 Resources

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json



# V1 Assets

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json



# V1 Ordered Data Stores

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json



# V1 Standard Data Stores

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json



# V1 Messaging

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json



# V1 Universes

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json

Extensões de vendedor

O Roblox usa extensões de especificação para estender a especificação da OpenAPI.Estas extensões representam informações que a especificação não captura por padrão.Extensões podem aparecer ao longo do arquivo onde for permitido pela especificação da OpenAPI.

A maioria dessas extensões de especificação é experimental.As extensões usadas estão sujeitas a mudanças sem aviso em favor de campos encontrados dentro da especificação oficial do OpenAPI.

Extensões de especificação de recursos V2

ExtensãoLocalizaçãoDescrição
x-categoriesObjeto OpenAPI Lista de strings.Todas as categorias de recursos.
x-visibilityObjeto de OperaçãoBooleano.A visibilidade da operação.
x-roblox-docsObjeto de OperaçãoObjeto.Associa uma operação a uma categoria e recurso.
x-long-running-operation-parametersObjeto de OperaçãoObjeto.Faz referência aos metadados e à resposta para a resposta de longa duração da operação.
x-aep-resourceObjeto de EsquemaObjeto.Uma extensão que anota o digitarde recurso.Tem compatibilidade próxima com AEP-4, uma das Propostas de Melhoria da API.
x-oneOfObjeto de EsquemaObjeto.Cada campo contém uma lista de propriedades no esquema.Apenas uma das propriedades deve estar presente.
x-resourceObjeto de EsquemaBooleano.Se o esquema é um recurso.
x-immutableObjeto de EsquemaBooleano.Se o esquema é imutável.

Extensões de especificação de recursos V1

ExtensãoLocalizaçãoDescrição
x-roblox-cloud-api-operationObjeto de OperaçãoBoolean.Se a operação é uma operação de Nuvem Aberta.
x-roblox-cloud-api-operation-nameOperação ObjetoString.O nome da operação.
x-roblox-cloud-api-operation-code-samplesObjeto de OperaçãoObjeto.Uma lista de amostras de código, um objeto com o idioma/título e o script correspondente.
x-roblox-cloud-api-operation-throttling-limitObjeto de OperaçãoObjeto.Os limites de aceleramento para a operação.