REST API Tasarım Prensipleri

Nedim Bilgiç 6 dk okuma

REST (Representational State Transfer), web servisleri tasarlamak için kullanılan bir mimari stildir. Doğru tasarlanmış bir REST API, ölçeklenebilir, bakımı kolay ve kullanıcı dostu bir arayüz sunar.

Kaynak Odaklı URL Tasarımı

REST API'lerde URL'ler kaynakları temsil etmelidir:

GET    /api/v1/users          // Tüm kullanıcılar
GET    /api/v1/users/123      // Tek kullanıcı
POST   /api/v1/users          // Yeni kullanıcı
PUT    /api/v1/users/123      // Güncelleme
DELETE /api/v1/users/123      // Silme

HTTP Metotlarının Doğru Kullanımı

  • GET: Veri okuma, yan etkisiz olmalı
  • POST: Yeni kaynak oluşturma
  • PUT: Kaynağın tamamını güncelleme
  • PATCH: Kısmi güncelleme
  • DELETE: Kaynak silme

Durum Kodları

Doğru HTTP durum kodları kullanmak, API'nin anlaşılabilirliğini artırır:

200 OK           - Başarılı istek
201 Created      - Kaynak oluşturuldu
204 No Content   - Başarılı silme
400 Bad Request  - Geçersiz istek
401 Unauthorized - Kimlik doğrulama gerekli
404 Not Found    - Kaynak bulunamadı
429 Too Many     - Rate limit aşıldı
500 Server Error - Sunucu hatası

Versiyonlama

API değişiklikleri mevcut istemcileri bozmamalıdır. URL tabanlı versiyonlama en yaygın yaklaşımdır:

/api/v1/users
/api/v2/users

Sonuç

İyi tasarlanmış bir REST API, geliştirici deneyimini doğrudan etkiler. Tutarlı URL yapısı, doğru HTTP metotları ve anlamlı hata mesajları ile kullanıcı dostu bir API oluşturabilirsiniz.

NB
Nedim Bilgiç

Backend Developer. Kurumsal web siteler, e-ticaret çözümleri ve özel yazılım projeleri geliştiriyorum.