HTTP 202 ile Asenkron Job API: Status, Retry ve Sonuç Endpoint'i Tasarımı

Problemi doğru sınırlandırın

Dakikalar süren export, import veya rapor işlerini HTTP bağlantısını açık tutmadan 202 Accepted, job resource ve polling modeliyle sunun.

Bu rehberin odak noktası uzun süren sunucu işini istemciye güvenilir bir durum kaynağıyla temsil etmek. Örnek senaryo gerçek bir müşteri vakası değil, karar mantığını görünür kılmak için hazırlanmış varsayımsal bir çalışma örneğidir: Müşteri 500 bin satırlık rapor istiyor; senkron endpoint proxy timeout nedeniyle başarısız görünüyor ama iş arka planda sürüyor.

Entegrasyonlarda mutlu yol genellikle en kolay kısımdır. Gerçek dayanıklılık; tekrar teslim, zaman aşımı, kısmi hata, sıra bozulması, sürüm farkı ve yetkisiz çağrı gibi sınır durumlarında ortaya çıkar.

Karar çerçevesi

Bu durumda temel karar şudur: POST isteği job kimliği döndürsün; job resource pending, running, succeeded, failed ve cancelled durumlarını açık tanımlasın. Bu kararın değeri, ekip tarafından aynı şekilde yorumlanabilmesi ve testle kanıtlanabilmesidir. Belirsiz ifadeler yerine gözlenebilir davranış, sorumlu sistem ve hata halinde beklenen sonuç yazılmalıdır. Uygulama ayrıntısı: Retry-After veya istemci backoff önerisiyle polling yükünü sınırlayın; job event veya webhook seçeneği varsa aynı durum modeline bağlayın.

API sözleşmesine kimlik, tekrar davranışı, hata semantiği ve gözlem alanlarını baştan eklemek; sonradan yama yapmak yerine güvenilir entegrasyonu tasarımın parçası haline getirir.

Dört uygulama ve kabul kontrolü

Birinci kontrol “202 response'ta status URL döndürün” olmalıdır. Bunun için önce mevcut durumdan örnek kayıt veya trafik seçin, beklenen sonucu önceden yazın ve değişiklikten sonra aynı örnekleri yeniden çalıştırın. Kontrolün sahibi ile kanıtın saklanacağı yer belli değilse, test tamamlandı denmemelidir.

İkinci kontrol “Aynı isteğin idempotency davranışını tanımlayın” maddesidir. Bu kontrol yalnızca başarılı senaryoda değil; boş veri, gecikme, tekrar, yetkisiz kullanıcı veya bağlantı sorunu gibi sınır koşullarında da denenmelidir. Böylece sistemin yalnızca demo sırasında değil gerçek operasyon baskısı altında nasıl davrandığı anlaşılır.

Üçüncü kontrol “Failed durumda makine okunur hata verin” olarak tanımlanmıştır. Uygulama ekibi teknik logları izlerken operasyon ekibi aynı olayın kullanıcı veya iş sonucu üzerindeki etkisini görebilmelidir. İki görünüm arasında ilişki kurulması, sorunun kaynağını daha hızlı ayırmaya yardımcı olur.

Yayın öncesinde uzun süren sunucu işini istemciye güvenilir bir durum kaynağıyla temsil etmek bağlamında tamamlanan sonuç için saklama süresi belirleyin için hazırlığı somutlaştırmalısınız. Bu kontrol hangi test verisiyle yapılacak, beklenen davranış nasıl ölçülecek, arızalı sonucun kullanıcıya görüntüsü ne olacak, ve bulunursa veri nasıl düzeltilecek—tüm bunlar yazılı olmalıdır. Sorumlu kişi, kanıt deposu ve geri alma adımları belirlenmek üzere bir form doldurmalısınız.

Riskleri yayın öncesinde görünür kılın

Yayından sonra ilk 24 saat kritiktir. Normal durumda beklediğiniz sinyalleri (işlem sayısı, hata oranı, yanıt süresi) önceden yazın; hangi değerler alarm üreteceği ve kim baktığını belirleyin. aynı exportun tekrar tekrar başlaması gerçekleşirse geri alma kararını kimin vereceği ve kaç dakika içinde uygulanacağı belli olmalıdır. Ardından tamamlanan sonuç için saklama süresi belirleyin yeniden çalıştırarak değişikliğin hala güvenli olduğunu kanıtlayın. Kanıt planı: İş süresini yapay geciktirip istemcinin bağlantı kesilse bile job durumunu daha sonra doğru okuyabildiğini doğrulayın.

Kabul kriterini operasyonla bağlayın

Dördüncü kontrol “Tamamlanan sonuç için saklama süresi belirleyin” maddesidir. Bu son adım çoğu projede atlanır; oysa yayın öncesi kabul listesinin bir parçası olduğunda değişikliğin ne zaman gerçekten tamamlandığı netleşir. Kontrol sonuçları tarih, sürüm ve sorumlu ile kaydedilmelidir.

Birincil kaynaklarla teknik çerçeveyi doğrulayın

Risk analizi üç görünür başlıkta tutulabilir. Birincisi “İstemcinin sonsuz polling yapması”. Bu risk için erken uyarı sinyali, etkilenebilecek kayıt veya kullanıcı kapsamı ve geri alma adımı yazılmalıdır. İkincisi “İş başarısızken 200 sonucu göstermek”; bunu yalnızca log hatası olarak değil veri veya müşteri etkisi olarak da ölçün. Üçüncüsü “Aynı exportun tekrar tekrar başlaması”; bu risk gerçekleşmese bile test senaryosunda kasıtlı olarak tetiklenerek kontrolün işe yaradığı kanıtlanabilir.

• IETF RFC 9110 — HTTP Semantics
• Stripe Docs — Idempotent Requests

Yayın, gözlem ve geri dönüş planı

Kabul tablosu proje yönetim aracı yerine geçmez; ekiplerin aynı 'bitti' tanımını kullanmasını sağlar. Her kontrol için örnek veri, beklenen sonuç, gözlem noktası ve sorumlu belirlemek; sonradan yaşanan tartışmayı yayın öncesi karara dönüştürür. Eğer bir kontrol otomatikleştirilebiliyorsa regresyon testine eklenmesi, manuel kalıyorsa tekrar çalıştırılabilecek kısa bir runbook'a bağlanması yararlıdır. Kapsam sınırı: 202 yanıtını başarı tamamlandı anlamında kullanmayın; yalnız isteğin kabul edildiğini, nihai sonucun job kaynağından izleneceğini açıkça anlatın.

Teknik çerçeveyi kontrol ederken bu rehberde IETF RFC 9110 — HTTP Semantics, Stripe Docs — Idempotent Requests birincil dokümantasyonları referans alınmıştır. Bu kaynaklar kullanılan kavramların ve platform davranışlarının resmi açıklamalarını sağlar; ancak sizin veri modeliniz, sözleşmeleriniz, trafik profiliniz ve güvenlik gereksiniminiz için nihai tasarım kararı değildir. Uygulama öncesinde kullanılan ürün/sürüm dokümantasyonu yeniden kontrol edilmelidir.

Yayın planında üç kapı kullanın: önce yapısal doğrulama, sonra sınırlı gerçek kullanım, son olarak genişletme. İlk kapıda şema, yetki, hata ve veri bütünlüğü test edilir. İkinci kapıda gerçek trafik veya temsil edici kullanıcı grubu üzerinden performans ve davranış izlenir. Üçüncü kapıya yalnızca belirlenen hata bütçesi ve iş metriği sınırları içinde kalındığında geçilir. Bu sıra, değişikliği yavaşlatmak için değil geri bildirim maliyetini düşürmek için vardır.

Sık sorulan sorular

HTTP 202 ile Asenkron Job API için ilk adım nedir?

Önce problemi teknik çözüm adıyla değil iş etkisiyle sınırlayın. Bu rehberdeki senaryoda başlangıç noktası uzun süren sunucu işini istemciye güvenilir bir durum kaynağıyla temsil etmek. Ardından mevcut davranışı ölçün ve ilk kabul kriterini 202 response'ta status URL döndürün şeklinde somutlaştırın.

Bu çalışma tek seferde canlıya alınmalı mı?

Genellikle hayır. En güvenli yaklaşım, değişikliği küçük bir kapsamda doğrulayıp gözlem sinyallerini izlemektir. Özellikle “İstemcinin sonsuz polling yapması” riski gerçekleştiğinde geri dönüş veya telafi adımının önceden tanımlı olması gerekir.

API ve Entegrasyon projesinde başarı nasıl kabul edilir?

Başarı yalnızca ekranın veya endpoint'in çalışması değildir. Aynı isteğin idempotency davranışını tanımlayın ve failed durumda makine okunur hata verin birlikte doğrulanmalı; hata, tekrar ve yetki gibi sınır durumları için de ölçülebilir kanıt üretilmelidir.

Bu içerikteki senaryo ve kabul örnekleri açıklama amacıyla hazırlanmış varsayımsal örneklerdir; müşteri sonucu, fiyat, sertifikasyon veya performans garantisi değildir. Platform davranışları uygulama tarihinde güncel birincil dokümantasyondan yeniden doğrulanmalıdır.