Bir API çalıştırmak, içerik türü bir başlığı düzeltirsem müşteriler için bir şeyleri kırar mı?

Kullanmakta olan birkaç kişiyle bir API çalıştırıyoruz. Benim açımdan bazı eski sakarlıklardan dolayı, uç noktalardan biri , ne zaman olması gerektiğinde yanlış içerik türü üstbilgisini döndürüyor . Benim sorum, doğru değeri döndürmek için değiştirerek bunu düzeltirsek, mevcut müşterilerimiz için işleri ne kadar berbat edebilir? Ya da başka bir deyişle, birçok farklı HTTP istemci kütüphanesinin böyle bir değişiklik görürken ölümcül hatalar atmasını bekler misiniz?jsjson

Bunun, çok fazla terlemeden devam edebileceğimiz ve yapabileceğimiz bir değişiklik olup olmadığına karar vermeye çalışıyoruz veya tüm kullanıcılara dikkatlice e-posta göndermeli ve çok yıllı bir kullanım dışı kalma süresi ... veya aradaki bir şeyi duyurmalıyız.

Muhtemelen ne tür farklı HTTP istemcilerinin kullanıldığına bağlıdır, bu yüzden kullanıcı aracılarına bir göz attım. Cevap: birçok farklı soru! İşte en iyilerinden bazıları:

"okhttp / 3.2.0", "python istekleri / 2.10.0", "Ruby", "python istekleri / 2.7.0", "Mozilla / 5.0", "Java / 1.8.0_91", "python istekleri /2.4.3 "," okhttp / 3.3.0 "," Lucee "," Dalvik / 2.1.0 "," Google-HTTP-Java-İstemci / 1.21.0 "," PHP_appname "," NativeHost "," Java /1.7.0_67 "," Apache-HttpClient / UNAVAILABLE "," Dalvik / 1.6.0 "," Web sniffer / 1.1.0 "," unirest-objc / 1.1 "

Çeşitli farklı mobil ve sunucu tarafı dil kütüphaneleri. Çoğunlukla javascript çalıştıran tarayıcılar değil, bazıları da.

Çoğu kişi içerik türünün yanlış olduğunu fark etmiyor gibi görünüyor, ancak arada bir yeni destek talebi bu sorundan şikayetçi oluyor, bu yüzden düzeltmek istiyoruz.

mevcut müşterilerimiz için işleri ne kadar berbat edebilir?

Bu İçerik Türünün yanlış olmasına dayanan bir kod yazmışlarsa savaş gemilerini tamamen batırabilirler .

Kitaplıkların hata atmasını beklemem, ancak bazı durumlarda katı kitaplıkların davranışlarının yanlış MIME türünü işlemek için geçersiz kılınmasını bekliyorum.

API'nizin bir yerde bir istek alanında sürüm / düzeltme değeri varsa, onu yükseltin ve yeni sürümde doğru türü döndürün, ancak eski sürümlerde yanlış türü döndürmeye devam edin. Böyle bir istek alanınız yoksa, şimdi bir tane eklemek için iyi bir zaman.

Birçok değişik HTTP istemci kütüphanesinin böyle bir değişiklik görürken ölümcül hatalar atmasını bekler misiniz?

Hayır. Programcı özellikle bu üstbilgiyi okumadığı ve onunla bir şeyler yapmadığı sürece, tanıdığım her HTTP istemci kitaplığı içerik türü üstbilgisini yok sayar. Içerik türü: application / json otomatik olarak bir json ayrıştırıcı dahil neden bir kütüphane hayal edebiliyorum ama bunun gerçekte nerede olduğu herhangi bir durumda bilmiyorum.

Çoğu kişi içerik türünün yanlış olduğunu fark etmiyor gibi görünüyor, ancak arada bir yeni destek talebi bu sorundan şikayetçi oluyor, bu yüzden düzeltmek istiyoruz.

Yanlış başlığı nasıl fark ettiler? Buna bakmaya değer olabilir, çünkü yanlış başlık aslında sorunlara neden oluyorsa, açıkça görmezden gelmiyorlardı ve düzeltildiyse sorun yaşayabilirler.

Tüm müşterilerinizden çıkış yapmadan söylemek çok zor. API'nizi v.Next'e yükseltmek için aşağıdaki iki yaklaşımdan birini kullanmanızı öneririm.

1. Mevcut API'yı genişletin. API'nıza v.Next kullanmak için bir sorgu dizesi veya başka bir değişken ekleyin. Bu değişkeni kullanan tüm istekler için güncellenen içerik türünü kullanın.
2. Mevcut API'nize paralel olarak API'nizin bir Hazırlama veya Üretim Öncesi örneğini çalıştırın. Üretimle neredeyse aynı olmalıdır. Aynı arka ucu kullanarak bile. Her ne kadar bu v.Next için önerilen değişikliklere sahip olacak.

Her iki senaryoda da, yapmak istediğiniz değişiklikleri ve hedef hedef tarih / saatini müşterilerinize iletin. Hizmet kesintisi olmadığından emin olmak için onları hedef tarihten önce test etmeye teşvik edin.

V.Next'te yapılan değişiklikleri ayrıntılı olarak belirten özel bir sayfanız olduğundan emin olun. Bu, müşterilerinize gönderilen iletişimlere dahil edilmelidir. Mevcut istemcilerle ilgili herhangi bir düzeltmeyi ele aldıysanız, bu sayfaya bu düzeltmeleri ekleyin.

Son olarak, müşterilerinizle aşırı iletişim kurmak ve onları spam etmek arasındaki çizgiyi takip edin. Daha acil / acil öncelikler ortaya çıktıkça bu bildirimler kolayca gözden kaçabilir.

FWIW, eğer işler şu anda çalışıyorsa, bu konuda fazla endişelenmezdim. Örneğin, bunun önemli bir güvenlik açığına neden olduğunu fark ederseniz, bu değişikliği atmak için harika bir neden olacaktır. Aksi takdirde bu değişikliği dahil etmek için daha acil bir şey beklerdim.

Bunun kırılacağı bir kitaplık örneği (iyi, tek komut):

powershell cmdletInvoke-RestMethod JSON ile farklı davranır. İsteğin sonucu JSON, XML veya ATOM / RSS ise (ve başlığa dayandığını düşünüyorum), ayrıştırır / serisini kaldırır ve yerel nesneleri döndürür, aksi takdirde ham verileri döndürür.

Bu nedenle, mevcut kod bir dizeyle başa çıkmak için yazılır (belki de geçerek ConvertFrom-Json) ve aniden başarısız olmaya başlar.

İki sonuç fark ettim:

1. Bazı istemci kitaplıkları yanıtı düzgün işlemez. Örneğin, yanıt json veya bir dizi yerine bir dize döndürür.
2. Sıkıştırma her zaman uygulanmaz.