Uygulama düzeyinde olayları tanımlamak için HTTP durum kodları kullanmalı mıyım?

Ele aldığım birkaç sunucu, istemcinin bir başarısızlık olarak değerlendirmesi gereken talepler için HTTP 200'ü döndürür, vücutta 'başarı: yanlış' gibi bir şey olur.

Bu, özellikle başarısız kimlik doğrulama durumlarında bana HTTP kodlarının uygun bir şekilde uygulanması gibi gözükmüyor. '4xx' isteğin değiştirilinceye kadar tekrar yapılmaması gerektiğini belirtirken, '5xx' isteğin geçerli olabileceğini veya yeniden denenebileceğini ancak başarısız olduğunu belirtirken, özetle özetlenen HTTP hata kodlarını okudum. Bu durumda 200: oturum açma başarısız oldu veya 200: bu dosyayı bulamadı ya da 200: eksik parametre x, kesinlikle yanlış görünüyor.

Öte yandan, '4xx’in sadece istekle ilgili yapısal bir sorunu göstermesi gerektiği iddiasını görebiliyorum. Bu yüzden, 200'ü geri göndermek uygundur: 401 yetkisiz kullanıcı / şifre yerine izinsizdir, çünkü müşterinin talepte bulunmasına izin verilir, ancak yanlış olur. Bu argüman, eğer sunucu isteği işleme koyabildiyse ve bir karar verebiliyorsa, cevap kodu 200 olmalı ve daha fazla bilgi için gövdeyi kontrol etmek müşteriye kalmıştır.

Temel olarak, bu bir tercih meselesi gibi görünüyor. Ama bu tatmin edici değil, bu yüzden herhangi birinin bu paradigmalardan birinin daha doğru olmasının bir sebebi varsa bilmek isterim.

İlginç soru.

Temel olarak, OSI katmanlarına benzer şeyleri sınıflandırmak için bunu doğru şekilde azaltabiliriz. HTTP, genellikle Uygulama Seviyesi protokolü olarak tanımlanır ve HTTP gerçekten de genel bir İstemci / Sunucu protokolüdür.

Bununla birlikte, uygulamada, sunucu hemen hemen her zaman bir aktarma aygıtıdır ve istemci, içeriği yorumlamaktan ve oluşturmaktan sorumlu olan bir web tarayıcısıdır: Sunucu, işleri yalnızca rastgele bir uygulamaya iletir ve uygulamalar, tarayıcının istediği komut dosyalarını geri gönderir. yürütmekten sorumludur. HTTP etkileşiminin kendisi - istek / yanıt formları, durum kodları, vb. - çoğunlukla, rastgele içeriğin mümkün olduğunca verimli bir şekilde talep edilmeden nasıl sunulacağını, sunulmasını ve sunulmasını ilgilendirmez. Durum kodlarının ve başlıklarının çoğu gerçekten bu amaçlar için tasarlanmıştır.

Uygulamaya özgü akışları işlemek için HTTP protokolünü gizlemeye çalışmakla ilgili sorun, şu iki seçenekten biriyle kalmanızdır: 1) İsteğiniz / yanıt mantığınızı HTTP kurallarının bir alt kümesi yapmalısınız; veya 2) Belli kuralları tekrar kullanmalısınız ve endişelerin ayrılması bulanıklaşmaya meyillidir. Bu ilk bakışta güzel ve temiz görünebilir, ancak bence projeniz ilerledikçe pişmanlık duyduğunuz tasarım kararlarından biri.

Bu nedenle, protokollerin ayrılması konusunda açık olmanın daha iyi olacağını söyleyebilirim. HTTP sunucusu ve web tarayıcısı kendi şey yapalım ve uygulama yapalım onun kendi şey. Uygulamanın talepte bulunabilmesi gerekir ve cevaplara ihtiyacı vardır - ve nasıl talep edileceği, cevapları nasıl yorumlayacağına dair mantığı, HTTP perspektifinden daha karmaşık (veya daha az) olabilir.

Bahsedilmeye değer olan bu yaklaşımın bir başka yararı da, uygulamaların, genel olarak konuşursak, temel bir taşıma protokolüne (mantıksal bir bakış açısıyla) bağlı olmaması gerektiğidir. HTTP geçmişte değişti ve şimdi SPDY'yi izleyen HTTP 2'yi başlattık. Uygulamanızı bir HTTP işlevsellik eklentisinden başka bir şey olarak görmüyorsanız, yeni altyapılar devreye girdiğinde oraya sıkışmış olabilirsiniz.

Bu soru biraz görüş üzerine kuruludur, ancak iki şekilde de.

Gördüğüm gibi, 200 "yumuşak hatalara" hizmet edebilir. API oluşturmaya gelince, bunlar ile "sert hatalar" arasında ayrım yapmaya çalışıyorum.

"Yumuşak hatalar" 200 durum koduyla sunulacak, ancak bir hata açıklaması ve başarı durumu içerecektir false. "Yumuşak hatalar" yalnızca sonuç "beklendiği gibi" olduğunda gerçekleşir, ancak kesin anlamda başarılı olmaz.

"Yumuşak hataların" uygulayıcı için daha fazla ipucu olduğuna dikkat etmek önemlidir . Bu nedenle, insan tarafından okunabilir bir hata mesajı ve / veya son kullanıcıya geri bildirimde bulunmak için kullanılabilecek bir tür kod gibi hata hakkında daha fazla bilgi vermek önemlidir . Bu hatalar uygulayıcıya (ve son kullanıcıya) olayların sunucu tarafında olanlarla ilgili daha fazla bilgi sağlar .

Örneğin, arama işlevine sahip bir API’niz olduğunu ancak arama sırasında hiçbir sonuç alınmadığını varsayalım. Bu hatalı değil, ancak tanımı kesin anlamıyla değil, "başarı" da değil.

JSON olarak biçimlendirilmiş örnek:

{
    "meta" {
        "success": false,
        "message": "Search yielded no results",
        "code": "NORESULTS"
    }
    "data": []
}

Öte yandan "sert hatalar" , hata için önerilen durum koduyla birlikte sunulacaktır. Kullanıcı oturum açmamış mı? - 403 / 401. Yanlış biçimlendirilmiş giriş? - 400. Sunucu hatası? - 50X. Ve bunun gibi.

Yine, biraz fikir tabanlı. Bazı insanlar tüm hataları eşit, her şeyi "zor hata" olarak ele almak ister. Arama sonucu bulunamadı? Bu bir 404! Madalyonun diğer tarafında, arama sonucu yok mu? - Bu beklendiği gibi, hata yok.

Dikkate alınması gereken bir diğer önemli faktör, mimarlığınızdır; API'nizle JavaScript XHR isteklerini ve jQuery veya AngularJS'yi kullanarak etkileşimde bulunuyorsanız. Bu "sert hatalar" ayrı bir geri çağırma ile ele alınacak, oysa "yumuşak hatalar" geri çağırma "başarısı" ile ele alınabilir. Hiçbir şeyi kırmamak, sonuç hala "beklendiği gibi". Müşteri tarafı kodu daha sonra başarı durumuna ve koduna (veya mesajına) bakabilir. Ve bunu son kullanıcıya yazdır.

Bir API'nin iki yönü vardır: API'yi uygulama çabası ve tüm istemcilerin API'yi doğru kullanma çabası.

Müşterinin yazarı olarak, bir web sunucusuna bir istek gönderdiğimde, bir hata (sunucuya hiç doğru şekilde konuşmadım) veya durum koduyla bir cevap alabileceğimi biliyorum. Hataları ele almalıyım. İyi bir cevap vermem gerekiyor. Beklenen, belgelenmiş, "kötü" yanıtları ele almalıyım. Geri kalan her neyse onu ele almalıyım.

API'yi tasarlarken, müşterinin işlemesi için en kolay olana bakmalısınız. Müşteri iyi biçimlendirilmiş bir istek gönderirse ve isteğin sizden istediği şeyi yapabilirseniz, o zaman 200 aralığında bir yanıt vermelisiniz (bu aralıktaki 200'den farklı bir sayının uygun olduğu bazı durumlar vardır).

Müşteri "... gibi tüm kayıtları bana verir" diye sorarsa ve sıfır varsa, başarılı olan bir 200 ve sıfır kayıt dizisi tamamen uygundur. Bahsettiğiniz davalar:

"Giriş başarısız" genellikle 401 olmalıdır. "Dosya bulunamadı" 404 olmalı. "Eksik parametre x" 500 civarında bir şey olmalı (aslında, sunucunun isteğinin kötü olduğunu tespit etmesi durumunda 400, ve 500 Sunucu isteğimle tamamen karıştıysa ve ne olduğu hakkında hiçbir fikri yoksa). Bu durumda 200'e geri dönmek anlamsızdır. Sadece bir müşterinin yazarı demek, sadece durum koduna bakamıyorum, cevabı da çalışmak zorundayım. "Durum 200, harika, işte veriler" diyemiyorum.

Özellikle "parametre eksik" - bu benim başa çıkabileceğim bir şey değil . İsteğim yanlış. İsteğim yanlışsa, bu yanlış isteği düzeltmek için geri dönüşüm yok - başlamak için doğru bir istek gönderirdim. Şimdi bununla başa çıkmak zorundayım. 200 alıyorum ve bir cevap "parametresi eksik" olup olmadığını kontrol etmek zorundayım. Bu korkunç.

Sonunda, birçok farklı durumla başa çıkmak için bir düzine veya iki durum kodu vardır ve bunları kullanmanız gerekir.