Doğru HTTP metotlarından sürümlemeye, kimlik doğrulamadan hız sınırlamaya; üretime hazır bir REST API için işe yarayan 12 temel pratiği tek listede topladık.

İyi bir REST API; tahmin edilebilir, güvenli ve bakımı kolaydır. Üretime hazır bir API için yıllardır işe yarayan 12 temel pratiği derledik.

12 pratik

  1. Doğru HTTP metotları: GET (oku), POST (oluştur), PUT/PATCH (güncelle), DELETE (sil). Yan etkili işlemleri GET'e koymayın.
  2. Anlamlı durum kodları: 200/201/204, 400/401/403/404, 409, 422, 500 gibi kodları doğru kullanın.
  3. Kaynak-odaklı URL'ler: fiil değil isim: /users/42/orders, /getUserOrders değil.
  4. Sürümleme: kırıcı değişiklikler için /v1/ gibi bir sürüm stratejisi belirleyin.
  5. Sayfalama ve filtreleme: liste uçlarında sayfa boyutunu sınırlayın; büyük yanıtları asla tek seferde döndürmeyin.
  6. Kimlik doğrulama: token tabanlı (JWT/OAuth 2.0) kullanın; oturumları güvenli yönetin.
  7. Yetkilendirme: kimliği doğrulamak yetmez; her istekte kaynağa erişim yetkisini kontrol edin.
  8. Her yerde HTTPS: düz HTTP'yi kapatın; token ve verinin şifreli gitmesini garantileyin.
  9. Hız sınırlama (rate limiting): kötüye kullanımı ve kaba kuvvet saldırılarını engelleyin.
  10. Giriş doğrulama: gelen veriyi asla güvenilir saymayın; boyut/tür/aralık doğrulayın.
  11. Tutarlı hata formatı: tüm hataları aynı JSON şablonuyla döndürün (kod + mesaj + izleme kimliği).
  12. Dokümantasyon: OpenAPI/Swagger ile sözleşmeyi açık ve güncel tutun.

Özet

Bu 12 madde, bir API'yi "çalışıyor" seviyesinden "üretime hazır" seviyesine taşır. Hepsinin ortak noktası tutarlılık ve öngörülebilirliktir: istemciler API'nizle nasıl konuşacağını tahmin edebildiğinde entegrasyon kolaylaşır, hatalar azalır.

Etiketler:REST APIbackendgüvenliktasarımrehber