Middle
¿Qué reglas de nomenclatura de recursos en REST conoces?
sobes.tech AI
Respuesta de la IA
En las API RESTful, los recursos se nombran con sustantivos que representan colecciones o instancias de objetos.
Reglas de nomenclatura:
- Usa plural para colecciones:
GET /products,POST /users. - Para acceder a un recurso específico, usa el identificador:
GET /products/123,PUT /users/john_doe. - Los recursos anidados se nombran en jerarquía:
GET /users/john_doe/orders,DELETE /products/456/reviews/789. - Evita verbos en la URL: en lugar de
GET /getAllProducts, usaGET /products. Los métodos HTTP (GET,POST,PUT,DELETE) ya indican la acción. - Usa letras minúsculas:
GET /userses preferible aGET /Users. - Separa las palabras con guiones:
GET /product-categorieses preferible aGET /productCategories. - No uses extensiones de archivos:
GET /users/john_doees preferible aGET /users/john_doe.json. El tipo de datos se determina en los encabezadosContent-TypeyAccept. - Usa parámetros de consulta para filtrado, ordenamiento y paginación:
GET /products?category=electronics&sort=price&limit=10&offset=0.
Ejemplo:
// Obtener la lista de todos los pedidos para el usuario con ID 1
// GET /users/1/orders
// Crear un nuevo producto
// POST /products
// Obtener detalles del producto con ID 42
// GET /products/42
// Actualizar la reseña con ID 10 para el producto con ID 5
// PUT /products/5/reviews/10