Le pagine di riferimento nelle sezioni Open Cloud v2 e Open Cloud v1 sono generate da file JSON che sono descrizioni OpenAPI.Questi file utilizzano la versione 3.0.4 della specifica OpenAPI.
Questi file sono open source e possono essere utilizzati con strumenti come il Swagger Editor e Postman per testare le chiamate API e aiutare a velocizzare lo sviluppo.
Queste descrizioni OpenAPI sono ancora in fase di sviluppo attivo e possono contenere problemi.Le pagine sotto la sezione Risorse sono il riferimento ufficiale.
File di descrizione dell'OpenAPI
I file di descrizione dell'API aperta sono disponibili nei seguenti luoghi all'interno del repository creator-docs:
Estensioni venditore
Roblox utilizza estensioni di specifiche per estendere la specifica OpenAPI.Queste estensioni rappresentano informazioni che la specificazione non cattura per impostazione predefinita.Le estensioni possono apparire in tutto il file, laddove consentito dalla specifica OpenAPI.
La maggior parte di queste estensioni di specifiche è sperimentale.Le estensioni utilizzate sono soggette a cambiamenti senza avviso a favore dei campi trovati all'interno della specifica OpenAPI ufficiale.
Le descrizioni OpenAPI per le risorse V1 e V2 utilizzano estensioni di specifiche distinte a causa delle differenze di implementazione sottostanti.
Estensioni della specifica risorsa V2
| Estensione | Luogo | Descrizione |
|---|---|---|
| x-categories | Oggetto OpenAPI | Lista di stringhe.Tutte le categorie di risorse. |
| x-visibility | Oggetto di operazione | Boolean.La visibilità dell'operazione. |
| x-roblox-docs | Oggetto di operazione | Oggetto.Associa un'operazione con una categoria e una risorsa. |
| x-long-running-operation-parameters | Oggetto di operazione | Oggetto.Fai riferimento ai metadati e alla risposta per la lunga risposta in esecuzione dell'operazione. |
| x-aep-resource | Oggetto schema | Oggetto.Un'estensione che annota il inserisci / scrividi risorsa.Ha una stretta compatibilità con AEP-4 , uno dei Proposte di miglioramento dell'API . |
| x-oneOf | Schema Object | Oggetto.Ogni campo contiene un elenco di proprietà nello schema.Solo una delle proprietà dovrebbe essere presente. |
| x-resource | Oggetto Schema | Boolean.Se lo schema è una risorsa. |
| x-immutable | Oggetto Schema | Boolean.Se lo schema è immutabile. |
Estensioni della specifica risorsa V1
| Estensione | Luogo | Descrizione |
|---|---|---|
| x-roblox-cloud-api-operation | Oggetto di operazione | Boolean.Se l'operazione è un'operazione Open Cloud. |
| x-roblox-cloud-api-operation-name | Oggetto di operazione | String.Il nome dell'operazione. |
| x-roblox-cloud-api-operation-code-samples | Oggetto di operazione | Oggetto.Un elenco di esempi di codice, un oggetto con la lingua/titolo e lo script corrispondente. |
| x-roblox-cloud-api-operation-throttling-limit | Oggetto di operazione | Oggetto.I limiti di accensione per l'operazione. |