Sobes.tech
Middle

Que regras de nomenclatura de recursos no REST conheces?

sobes.tech IA

Resposta da IA

Numa API RESTful, os recursos são nomeados com substantivos que representam coleções ou instâncias de objetos.

Regras de nomenclatura:

  • Use o plural para coleções: GET /products, POST /users.
  • Para aceder a um recurso específico, use o identificador: GET /products/123, PUT /users/john_doe.
  • Recursos aninhados são nomeados hierarquicamente: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
  • Evite verbos na URL: em vez de GET /getAllProducts, use GET /products. Os métodos HTTP (GET, POST, PUT, DELETE) já indicam a ação.
  • Use letras minúsculas: GET /users é preferível a GET /Users.
  • Separe as palavras com hífens: GET /product-categories é preferível a GET /productCategories.
  • Não use extensões de ficheiros: GET /users/john_doe é preferível a GET /users/john_doe.json. O tipo de dado é determinado nos cabeçalhos Content-Type e Accept.
  • Use parâmetros de consulta para filtragem, ordenação e paginação: GET /products?category=electronics&sort=price&limit=10&offset=0.

Exemplo:

// Obter a lista de todos os pedidos para o utilizador com ID 1
// GET /users/1/orders

// Criar um novo produto
// POST /products

// Obter detalhes do produto com ID 42
// GET /products/42

// Atualizar a opinião com ID 10 para o produto com ID 5
// PUT /products/5/reviews/10