Sobes.tech
Middle

Quali regole di denominazione delle risorse in REST conosci?

sobes.tech AI

Risposta dell'AI

In un'API RESTful, le risorse sono denominate con sostantivi che rappresentano collezioni o istanze di oggetti.

Regole di denominazione:

  • Usa il plurale per le collezioni: GET /products, POST /users.
  • Per accedere a una risorsa specifica, usa l'identificatore: GET /products/123, PUT /users/john_doe.
  • Le risorse annidate sono denominate gerarchicamente: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
  • Evita verbi nell'URL: invece di GET /getAllProducts, usa GET /products. I metodi HTTP (GET, POST, PUT, DELETE) indicano già l'azione.
  • Usa lettere minuscole: GET /users è preferibile a GET /Users.
  • Separa le parole con trattini: GET /product-categories è preferibile a GET /productCategories.
  • Non usare estensioni di file: GET /users/john_doe è preferibile a GET /users/john_doe.json. Il tipo di dati è determinato dagli header Content-Type e Accept.
  • Usa parametri di query per filtrare, ordinare e paginare: GET /products?category=electronics&sort=price&limit=10&offset=0.

Esempio:

// Ottieni l'elenco di tutti gli ordini per l'utente con ID 1
// GET /users/1/orders

// Crea un nuovo prodotto
// POST /products

// Ottieni i dettagli del prodotto con ID 42
// GET /products/42

// Aggiorna la recensione con ID 10 per il prodotto con ID 5
// PUT /products/5/reviews/10