Sobes.tech
Middle

REST'te kaynak isimlendirme kurallarını biliyor musun?

sobes.tech yapay zeka

AI'dan gelen yanıt

RESTful API'de kaynaklar, nesne koleksiyonlarını veya örneklerini temsil eden isimli isimlerle adlandırılır.

İsimlendirme kuralları:

  • Koleksiyonlar için çoğul kullanın: GET /products, POST /users.
  • Belirli bir kaynağa erişmek için kimliği kullanın: GET /products/123, PUT /users/john_doe.
  • İç içe kaynaklar hiyerarşik olarak adlandırılır: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
  • URL'de fiil kullanmaktan kaçının: GET /getAllProducts yerine GET /products kullanın. HTTP metodları (GET, POST, PUT, DELETE) zaten işlemi belirtir.
  • Küçük harf kullanın: GET /users tercih edilir, GET /Users yerine.
  • Kelimeleri tire ile ayırın: GET /product-categories, GET /productCategories yerine.
  • Dosya uzantıları kullanmayın: GET /users/john_doe tercih edilir, GET /users/john_doe.json yerine. Veri tipi, Content-Type ve Accept başlıklarında belirlenir.
  • Filtreleme, sıralama ve sayfalamak için sorgu parametreleri kullanın: GET /products?category=electronics&sort=price&limit=10&offset=0.

Örnek:

// Kullanıcı ID'si 1 olan kullanıcının tüm siparişlerini alın
// GET /users/1/orders

// Yeni bir ürün oluştur
// POST /products

// ID'si 42 olan ürünün detaylarını alın
// GET /products/42

// ID'si 10 olan yorumu, ID'si 5 olan ürün için güncelleyin
// PUT /products/5/reviews/10