Convenciones de nombres en REST API: URLs, métodos y claves JSON

Una REST API bien nombrada es intuitiva, consistente y autodocumentada. La mayoría de las APIs de producción siguen estas convenciones.

Convenciones de rutas URL

• Usa kebab-case o minúsculas para las rutas URL: /user-profiles
• Usa sustantivos en plural para colecciones: /users, /orders
• Usa IDs de recurso para elementos individuales: /users/123
• Anida subrecursos: /users/123/orders
• Evita verbos en las URLs: POST /users no POST /create-user

Métodos HTTP

Método	Propósito	Ejemplo
GET	Leer	GET /users/123
POST	Crear	POST /users
PUT	Actualización completa	PUT /users/123
PATCH	Actualización parcial	PATCH /users/123
DELETE	Eliminar	DELETE /users/123

Claves de respuesta JSON

Usa camelCase (estilo Google) o snake_case (estilo GitHub/Stripe). Elige uno y sé consistente en todos los endpoints.

Parámetros de consulta

Usa snake_case o camelCase de forma consistente: ?page_size=20&sort_by=created_at

Convertir formatos

Conversor a kebab-case para URLs, camelCase o snake_case para claves JSON. Prueba el hub.