Roblox pubblica un documento OpenAPI 3.0.4 (precedentemente noto come file Swagger) che contiene tutte le API Cloud di Roblox. Puoi trovare questo file, openapi.json, nel repository open source creator-docs.
Puoi utilizzare i documenti OpenAPI con strumenti come l'Swagger Editor e Postman per testare le chiamate e aiutare a semplificare lo sviluppo. Strumenti come OpenAPI Generator possono anche generare librerie client per i tuoi linguaggi di programmazione preferiti.
Questo documento è ancora in fase di sviluppo attivo e può contenere problemi. Segnala un bug se noti informazioni inaccurate.
Estensioni fornitore
Roblox utilizza estensioni di specifica per estendere la specifica OpenAPI. Queste estensioni rappresentano informazioni che la specifica non cattura per default. Le estensioni possono apparire in tutto il file dove consentito dalla specifica OpenAPI.
La maggior parte di queste estensioni di specifica è sperimentale. Le estensioni utilizzate sono soggette a modifiche senza preavviso a favore dei campi trovati all'interno della specifica OpenAPI ufficiale.
| Estensione | Posizione | Descrizione |
|---|---|---|
| x-roblox-extensions-version | Oggetto OpenAPI | Una stringa di versione, utilizzando il versioning semantico, che rappresenta le versioni delle estensioni specificate qui e altre strutture comuni |
| x-roblox-stability | Oggetto Operazione | Una stringa che rappresenta il livello di stabilità di un'operazione. |
| x-roblox-deprecated | Oggetto Operazione | Un oggetto che fornisce ulteriori informazioni relative allo stato di deprecazione di un endpoint. |
| x-roblox-alternatives | Oggetto Operazione | Un oggetto che fornisce ulteriori informazioni relative alle alternative di un endpoint. |
| x-roblox-rate-limits | Oggetto Operazione | Un oggetto che fornisce informazioni sui limiti di frequenza per un endpoint. |
| x-roblox-scopes | Oggetto Operazione | Un oggetto che fornisce l'elenco degli ambiti richiesti, condizionali e facoltativi associati a un endpoint. |
| x-roblox-engine-usability | Oggetto Operazione | Un oggetto che indica l'usabilità dell'endpoint con il motore Roblox. |