REST, ağ üzerinden çalışan uygulamaları resource'lar ve standart HTTP semantiği etrafında tasarlamak için kullanılan bir mimari yaklaşımdır. REST tarzı bir API; URL'lerini, metodlarını ve yanıtlarını öngörülebilir hale getirmelidir.
Resource yaklaşımı
URL'leri aksiyon isimlerine göre adlandırmak yerine uygulamanın sunduğu resource'ları modelleyin. Örneğin /products bir ürün koleksiyonunu temsil edebilir.
HTTP metodları
- GET veri okur
- POST yeni bir resource oluşturur
- PUT/PATCH bir resource'u günceller
- DELETE bir resource'u siler
Status kodları
Status code'ları tutarlı kullanın: başarılı okuma için 200, oluşturma için 201, gövdesiz başarılı yanıt için 204, geçersiz input için 400 ve resource bulunamadığında 404.
İyi API tasarımı
API daha fazla client tarafından kullanılmaya başladıkça tutarlı isimlendirme, validation, authentication, hata sözleşmeleri ve versioning giderek daha önemli hale gelir.
