Sobes.tech
Middle

REST-də resursların adlandırılması qaydalarını bilirsinizmi?

sobes.tech Süni İntellekt

AI-dan cavab

RESTful API-də resurslar, obyektlərin kolleksiyalarını və ya nümunələrini təmsil edən isimlərlə adlandırılır.

Adlandırma qaydaları:

  • Kolleksiyalar üçün çoxluq forması istifadə edin: GET /products, POST /users.
  • Müəyyən bir resursa giriş üçün identifikatoru istifadə edin: GET /products/123, PUT /users/john_doe.
  • İç-içə resurslar hierarxik olaraq adlandırılır: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
  • URL-də fellərdən istifadə etməyin: GET /getAllProducts əvəzinə GET /products istifadə edin. HTTP metodları (GET, POST, PUT, DELETE) artıq əməliyyatı göstərir.
  • Kiçik hərflərdən istifadə edin: GET /users üstünlük təşkil edir, GET /Users əvəzinə.
  • Kəlamları tire ilə ayırın: GET /product-categories üstünlük təşkil edir, GET /productCategories əvəzinə.
  • Fayl uzantılarından istifadə etməyin: GET /users/john_doe üstünlük təşkil edir, GET /users/john_doe.json əvəzinə. Məlumat tipi Content-TypeAccept başlıqlarında müəyyən edilir.
  • Filtrləmə, sıralama və səhifələmə üçün sorğu parametrlərindən istifadə edin: GET /products?category=electronics&sort=price&limit=10&offset=0.

Nümunə:

// İstifadəçi ID-si 1 olan istifadəçi üçün bütün sifarişlərin siyahısını alın
// GET /users/1/orders

// Yeni məhsul yaradın
// POST /products

// ID-si 42 olan məhsulun detalları
// GET /products/42

// ID-si 10 olan rəy üçün, ID-si 5 olan məhsul üçün yeniləyin
// PUT /products/5/reviews/10