Bilgi bankası

Tipli SDK'lar

Önce bir TypeScript istemcisi, sonra geri kalanı.

Ayrıntılar

npm'de yayımlandı ve kullanımda. @openemail/sdk, ESM ve CommonJS olarak yayımlanan, bağımlılığı olmayan eksiksiz bir TypeScript istemcisidir; API'nin sunduğu her belgelenmiş işlem için bir metot ve bunlara ek olarak bir istemci üretecinin ihtiyaç duyduğu iki kimliksiz meta uç noktası içerir. Anahtar OPENEMAIL_API_KEY değişkeninden okunur; deneme başına 30 saniyelik zaman aşımı, iki yeniden deneme, birkaç çalışma alanına hizmet eden bir süreç için çağrı bazlı apiKey geçersiz kılma ve imleç döngüsünü yazmadan bir listeyi sayfalamak için emails.iterate() vardır. Node 18 ve üzerinde, Workers, Deno, Bun ve tarayıcıda çalışır. Öneki yanlış olan bir anahtar, ilk çağrıda 401 vermek yerine nesne oluşturulurken hata fırlatır; denetim yalnızca önekten ibarettir, dolayısıyla biçimi doğru olan ama iptal edilmiş bir anahtar yine hat üzerinde başarısız olur.
İstemci, her derlemede OpenAPI belgesini okuyan ve ikisi ayrışırsa başarısız olan bir eşlik denetimiyle sunucuya bağlı tutulur: spesifikasyonda bulunmayan bir işleme işaret eden bir metot, metodu olmayan belgelenmiş bir işlem, işlemin gerektirdiğiyle uyuşmayan bir kapsam listesi, metotları olup referansta girişi olmayan bir ad alanı ya da kendi bildirdiği isteği göndermeyen bir metot. Neyi kanıtladığını yazdırır ve bugün bu, 104 belgelenmiş işlemin tamamını kapsayan 116 SDK metodu olarak okunur. Yanında iki üreteç betiği durur ve sınıflandırılmamış ya da uzun tire ile yazılmış bir işlemi üretmeyi reddeder. İstemcinin sonradan yazılmış bir sarmalayıcı olmamasının nedeni budur. API'nin bir sürüm gerisinde kalamaz.
Eksik olan, yayınlama tesisatı. Paket npm'de, dolayısıyla bun add @openemail/sdk çalışıyor, ama bir yayın iş akışı yok: yayımlamak, ön denetimin, derlemenin ve bun publish komutunun elle çalıştırılmasıdır; bu da bir sürümün npm'e değişiklik girdiğinde değil birisi hatırladığında ulaşması demektir. Varsayılan olarak kullandığı API ise açık ve yanıt veriyor.
Tek dil TypeScript'tir ve geri kalanı için yanıt, farklı hızlarda geride kalan beş elle yazılmış istemci yerine bilinçli olarak OpenAPI belgesidir. Depoda Python, Go ya da Ruby istemcisi yoktur ve belge onların üretileceği kaynak olmadan da olmayacaktır.