Gerçekten İşe Yarayan RESTful API Tasarım İlkeleri
İyi tasarlanmış bir API, geliştiricilerin severek kullandığı bir API'dir. Pratik RESTful API tasarım ilkelerini ve gerçek dünya deneyimlerimizi paylaşıyoruz.
URL Yapısı
Kaynak odaklı URL'ler kullanın:
- Çoğul isimler tercih edin (/users, /products)
- Fiillerden kaçının (/getUser yerine GET /users/:id)
- İç içe kaynakları mantıklı kullanın (/users/:id/orders)
HTTP Metodları
Her metodu amacına uygun kullanın:
- GET: Veri okuma (idempotent)
- POST: Yeni kaynak oluşturma
- PUT: Kaynağı tamamen güncelleme
- PATCH: Kaynağı kısmen güncelleme
- DELETE: Kaynak silme
Hata Yönetimi
Tutarlı hata yanıtları sağlayın. Her hata yanıtı şunları içermelidir: HTTP durum kodu, hata kodu, insan tarafından okunabilir mesaj ve varsa detaylar.
Sayfalama ve Filtreleme
Büyük veri setleri için cursor-based pagination tercih edin. Offset-based pagination, büyük veri setlerinde performans sorunlarına yol açabilir.
Versiyon Yönetimi
API versiyonlamayı baştan planlayın. URL path versiyonlama (v1, v2) en yaygın ve anlaşılır yaklaşımdır.
Rate Limiting
API'nizi kötüye kullanımdan koruyun. Rate limit bilgilerini response header'larında döndürün.
Sonuç
İyi bir API tasarımı, tutarlılık ve öngörülebilirlik üzerine kuruludur. Geliştiricilerin beklentilerini karşılayan, iyi dokümante edilmiş API'ler oluşturun.
