Sobes.tech
Middle

Koje pravila za imenovanje resursa u REST poznaješ?

sobes.tech АИ

Одговор од АИ

U RESTful API resursi se imenuju imenima koja predstavljaju kolekcije ili instance objekata.

Pravila imenovanja:

  • Koristite množinu za kolekcije: GET /products, POST /users.
  • Za pristup određenom resursu koristite identifikator: GET /products/123, PUT /users/john_doe.
  • Ugnježdeni resursi se imenuju hijerarhijski: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
  • Izbegavajte glagole u URL-u: umesto GET /getAllProducts, koristite GET /products. HTTP metode (GET, POST, PUT, DELETE) već ukazuju na radnju.
  • Koristite mala slova: GET /users je preferirano u odnosu na GET /Users.
  • Razdvajajte reči crticom: GET /product-categories je preferirano u odnosu na GET /productCategories.
  • Ne koristite ekstenzije fajlova: GET /users/john_doe je preferirano u odnosu na GET /users/john_doe.json. Tip podataka se određuje u zaglavljima Content-Type i Accept.
  • Koristite parametre upita za filtriranje, sortiranje i paginaciju: GET /products?category=electronics&sort=price&limit=10&offset=0.

Primer:

// Dobijanje liste svih porudžbina za korisnika sa ID 1
// GET /users/1/orders

// Kreiranje novog proizvoda
// POST /products

// Dobijanje detalja o proizvodu sa ID 42
// GET /products/42

// Ažuriranje recenzije sa ID 10 za proizvod sa ID 5
// PUT /products/5/reviews/10