OpenAPI açıklamaları

*Bu içerik, yapay zekâ (beta) kullanılarak çevrildi ve hatalar içerebilir. Sayfayı İngilizce görüntülemek için buraya tıkla.

Açık Bulut v2 ve Açık Bulut v1 bölümlerindeki referans sayfaları, OpenAPI açıklamaları olan JSON dosyalardan renderlanır.Bu dosyalar OpenAPI özelliklerinin versiyon 3.0.4 kullanır.

Bu dosyalar açık kaynaklıdır ve Swagger Editörü ve Postman gibi araçlarla API çağrılarını test etmek ve geliştirmeyi hızlandırmak için kullanılabilir.

Bu OpenAPI açıklamaları hala aktif gelişimde ve sorunlar içerebilir. Kaynaklar bölümünün altındaki sayfalar resmi referanstır.

OpenAPI açıklama dosyaları

OpenAPI açıklama dosyaları, yapımcı-dokümanlar deposundaki aşağıdaki konumlarda mevcuttur:

# 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

Satıcı uzantıları

Roblox, OpenAPI özelliğini genişletmek için özellik uzatmaları kullanır.Bu uzantılar, özelliklerin varsayılan olarak yakalamadığı bilgileri temsil eder.Genişletmeler, OpenAPI özelliklerine izin verildiğinde dosya boyunca görünebilir.

Bu özellik uzatmalarının çoğu deneyseldir.Kullanılan uzantılar, resmi OpenAPI özellikleri içinde bulunan alanlara göre bildirimde bulunmadan değiştirilebilir.

V2 kaynak özellik uzantıları

GenişletmeKonumAçıklama
x-categoriesOpenAPI NesnesiDize listesi.Tüm kaynak kategorileri.
x-visibilityOperasyon NesnesiBoolean.Operasyonun görünürlüğü.
x-roblox-docsOperasyon NesnesiNesne.Bir operasyonu bir kategori ve kaynakla ilişkilendirir.
x-long-running-operation-parametersOperasyon NesnesiNesne.Operasyonun uzun süren yanıtı için metadan ve yanıta referans verir.
x-aep-resourceŞema NesnesiNesne.Kaynak yaznot eden bir uzantı.AEP-4 ile yakın uyumluluğa sahiptir, API Geliştirme Önerilerinden biri.
x-oneOfŞema NesnesiNesne.Her alan, şemadaki özelliklerin bir listesini içerir.Sadece bir özellik mevcut olmalıdır.
x-resourceŞema NesnesiBoolean.Eşema bir kaynak mı yoksa değil mi.
x-immutableŞema NesnesiBoolean.Esas plan değiştirilemez olup olmadığı.

V1 kaynak özellik uzantıları

GenişletmeKonumAçıklama
x-roblox-cloud-api-operationOperasyon NesnesiBoolean.Operasyonun Açık Bulut operasyonu olup olmadığı.
x-roblox-cloud-api-operation-nameOperasyon NesnesiDize.Operasyonun adı.
x-roblox-cloud-api-operation-code-samplesOperasyon NesnesiNesne.Kod örnekleri listesi, dil/başlık ile ilgili bir nesne ve karşılık gelen kod.
x-roblox-cloud-api-operation-throttling-limitOperasyon NesnesiNesne.Operasyon için sınırlandırma sınırları.