Daha İyi REST API Tasarlamanın Yolları

 (r.bluethl.net)
26 puan yazan xguru 2022-03-11 | 2 yorum | WhatsApp'ta paylaş
  • Tutarlılığı koruyun: URL/header/kimlik doğrulama/durum kodları..
  • ISO8601 UTC tarih formatı kullanın
  • Yalnızca public endpoint'ler kimlik doğrulama istisnasıdır. Geri kalanların tümünde kimlik doğrulama zorunludur
  • Health check endpoint'i sağlayın
  • API versiyonlaması
  • API anahtarıyla kimlik doğrulama uygulayın
  • Mantıklı HTTP durum kodları ve metodları kullanın
  • Her endpoint için tek başına açıklayıcı, basit bir ad kullanın
  • Standart hata yanıtları kullanın
  • POST ile oluşturulan kaynağı geri döndürün
  • PUT yerine PATCH kullanın
  • Mümkün olduğunca spesifik olun
  • Pagination kullanın
  • Her kaynağı genişletilebilir tasarlayın (expand gibi query parametreleri vererek ek bilgilerin de döndürülebilmesini sağlayın)

İlgili okumalar

2 yorum

 
eajrezz 2022-03-14

Son zamanlarda ilgili içeriklere burada burada sıkça rastlıyorum; "Günlük Hayattaki Nesnelerin Anlattığı Web API Tasarımı" kitabını tavsiye ederim. Başlığı ve kapağı yüzünden internet üzerine kolay bir benzetme kitabı sanılabilir ama API tasarımını meslek edinmiş yazarın API tasarımına dair içgörüsünü öne çıkaran iyi bir kitap.