11. SınıfBilişim Teknolojileri
RESTful API Tasarımı ve JSON Akışı — Çalışma Sayfası
Kazanımlar, önemli noktalar ve sık yapılan hatalar tek sayfada.
Bu konuda öğrenecekleriniz
- Kaynak tabanlı tasarımda uç nokta adlandırmasını ve çok biçimli yanıtları doğru kurar.
- Sayfalama, sıralama ve filtreleme kurallarıyla istemcinin veri taşıma yükünü sınırlar.
- Sürümleme ve geriye uyum kurallarıyla istemci güncellemelerini güvenli biçimde yönetir.
- Hız sınırı, yeniden deneme ve tekrar etkisizlik kurallarını hata senaryolarına uygular.
- Hata yanıtlarını ortak bir sözleşmeyle standartlaştırıp izleme bilgisine dönüştürür.
Önemli noktalar
- Uç nokta adları çoğul kaynak adı ve tekil kayıt kimliğinden oluşur.
- Sayfalama olmadan tüm veri döndürmek sunucu ve ağ yükünü gereksiz artırır.
- Uyumlu olmayan alan değişiklikleri yeni sürüm gerektirir, sessizce değiştirilmez.
- Hız sınırı aşımında istek reddedilir ve bekleme süresi istemciye bildirilir.
- Kritik işlemlerde istek anahtarı ile çift kayıt oluşması engellenir.
- Hata yanıtı ortak sözleşmeye uyar ve izleme numarası taşır.
Formüller ve kurallar
- Sayfa sayısı = (toplam kayıt sayısı + sayfa boyutu - 1) / sayfa boyutu
- İstenen veri hacmi = istek sayısı × istek başına ortalama bayt
- Veri boyutu = kayıt sayısı × kayıt başına bayt
- Hata oranı = hata döndüren istek sayısı / toplam istek sayısı
- Ortalama yanıt süresi = toplam yanıt süresi / istek sayısı
- Kabul edilen istek oranı = izin verilen istek sayısı / gelen istek sayısı
- Sayfa boyutu etkisi = azalan istek sayısı = eski sayfa sayısı - yeni sayfa sayısı
Sık yapılan hatalar
- Her kaydı tek seferde döndürmek: Sınırsız veri döndürmek bellek ve ağ yükünü artırır, istemciyi kilitler. Sayfalama ile veri boyutu sınırlandırılmalıdır.
- Alan tipini sessizce değiştirmek: Uyumsuz değişiklikler eski istemcileri kırar. Yeni sürüm açılmalı, kullanımdan kaldırma tarihi ilan edilmelidir.
- Hız sınırını sıfırlamak: Sınır olmaması hatalı ya da kötüye kullanım amaçlı istemcilerin sunucuyu tüketmesine yol açar.
- Hata yanıtını boş bırakmak: Boş gövdeli hata, istemcinin sorunu tanımasını ve destekle iletişim kurmasını engeller. Ortak hata sözleşmesi kullanılmalıdır.
- Tekrarlanan kritik isteği aynı işlem saymak: Ağ hatası sonrası yeniden denenen istek ikinci kez işlem üretebilir. İstek anahtarı ile bu etki engellenmelidir.
Hızlı tekrar ipuçları
- Sözleşmeyi kod yazmadan önce kâğıtta tanımlayın: kaynak, alan, hata, sınır.
- Dönen veri boyutunu ölçün; sınırı aşan uç noktada sayfalama ekleyin.
- Uyumsuz her değişiklik için sürüm açın ve kaldırma tarihini duyurun.
- Hata yanıtlarına istek izleme numarası koyun, desteğe bu numarayla geçin.
- Hız sınırı aşımında bekleme bilgisini döndürün, istemciyi nazikçe yavaşlatın.
Kendini dene
Bu sayfayı okuduktan sonra konu anlatımını tekrar oku ve kendi cümlelerinle özetle.