OpenAPI ve makine sözleşmesi

DRAEVA public API için indirilebilir, servis sahibi tarafından doğrulanmış bir OpenAPI veya JSON Schema paketi henüz yayınlanmamıştır. Bu nedenle dokümantasyonda elle oluşturulmuş bir spec, resmi sözleşme gibi sunulmaz.

Güncel entegrasyon kaynağı

Şimdilik endpoint yolları, auth, alanlar, örnekler ve hata davranışları için API referans kapsamı altındaki sayfaları kullanın. JSON response işlerken:

• Gerekli alanları doğrulayın.
• Bilinmeyen ek alanları yok sayın.
• Enum olmayan sözlüklerin genişleyebileceğini kabul edin.
• application/problem+json response'larını ayrı şemayla işleyin.
• Binary Background Removal response'unun Content-Type ve PNG imzasını doğrulayın.

Yayınlanacak sözleşmenin kapsamı

Resmi makine sözleşmesi yayınlandığında en az şunları içermelidir:

• /look, /taxonomy ve /bg altındaki bütün public yollar
• Bearer ve X-API-Key security scheme'leri
• Endpoint-scope eşlemesi
• Multipart, JSON ve binary response tanımları
• Request/response modelleri, enum'lar ve limitler
• RFC 9457 Problem Details modelleri
• Rate-limit ve request-ID header'ları
• Örnek payload'lar

Neden geçici bir spec sunulmuyor?

Doğrulanmamış bir OpenAPI dosyası SDK üretimi ve otomatik doğrulamada yanlış güven oluşturur. Bir spec'in resmi sözleşme olarak sunulması için servis sahibinin deploy edilen davranışla uyumunu doğrulaması gerekir. Bu doğrulama henüz tamamlanmış olarak sunulmaz; yayın tarihi veya indirilebilir paket taahhüdü yoktur.

Production repoları ve commit'leri müşterilerle paylaşılmaz. Servis sahibinin dahili doğrulaması, müşteriye kaynak kod veya commit erişimi verilmesini gerektirmez. Ayrı staging/test ortamı yoktur; sözleşme doğrulama ihtiyacı ücretsiz test çağrıları veya sandbox sunulduğu anlamına gelmez.

Güncel kanıt sınırları için Doğrulama durumu sayfasına bakın.