Roblox, tüm Roblox Cloud API'lerini içeren bir OpenAPI 3.0.4 belgesi (önceden Swagger dosyası olarak biliniyordu) yayımlamaktadır. Bu dosyayı, açık kaynak creator-docs deposunda bulabilirsiniz.
OpenAPI belgelerini, çağrıları test etmek ve geliştirmeyi kolaylaştırmak için Swagger Editor ve Postman gibi araçlarla kullanabilirsiniz. OpenAPI Generator gibi araçlar, tercih ettiğiniz programlama dilleri için istemci kitaplıkları da oluşturabilir.
Tedarikçi uzantıları
Roblox, OpenAPI spesifikasyonunu genişletmek için spesifikasyon uzantıları kullanmaktadır. Bu uzantılar, spesifikasyonun varsayılan olarak yakalamadığı bilgileri temsil eder. Uzantılar, OpenAPI spesifikasyonunun izin verdiği yerlerde dosya boyunca görünebilir.
Bu spesifikasyon uzantılarının çoğu deneysel niteliktedir. Kullanılan uzantılar, resmi OpenAPI spesifikasyonunda bulunan alanlar lehine, bildirimsiz olarak değişiklik gösterebilir.
| Uzantı | Konum | Açıklama |
|---|---|---|
| x-roblox-extensions-version | OpenAPI nesnesi | Burada belirtilen uzantıların ve diğer ortak yapıların sürümlerini temsil eden, yapısal versiyonlamayı kullanan bir sürüm dizesi |
| x-roblox-stability | İşlem nesnesi | Bir işlemin stabilite seviyesini temsil eden bir dize. |
| x-roblox-deprecated | İşlem nesnesi | Bir uç noktanın kullanımdan kaldırılma durumu ile ilgili ek bilgi sağlayan bir nesne. |
| x-roblox-alternatives | İşlem nesnesi | Bir uç noktanın alternatifleri ile ilgili ek bilgi sağlayan bir nesne. |
| x-roblox-rate-limits | İşlem nesnesi | Bir uç nokta için oran sınırlama bilgileri sağlayan bir nesne. |
| x-roblox-scopes | İşlem nesnesi | Bir uç noktayla ilişkili gerekli, koşullu ve isteğe bağlı kapsamların listesini sağlayan bir nesne. |
| x-roblox-engine-usability | İşlem nesnesi | Uç noktanın Roblox motoruyla kullanımını gösteren bir nesne. |