Codigos de Respuestas

El servidor siempre debe retornar el codigo de estado HHTP correcto al cliente

  • 200OK - Respuesta a un exitoso GET, PUT, PATCH o DELETE. Puede ser usado también para un POST que no resulta en una creación.
  • 201Created – [Creada] Respuesta a un POST que resulta en una creación. Debería ser combinado con un encabezado Location, apuntando a la ubicación del nuevo recurso.
  • 204No Content – [Sin Contenido] Respuesta a una petición exitosa que no devuelve un body (como una petición DELETE)
  • 304Not Modified – [No Modificada] Usado cuando el cacheo de encabezados HTTP está activo
  • 400Bad Request – [Petición Errónea] La petición está malformada, como por ejemplo, si el contenido no fue bien parseado.
  • 401Unauthorized – [Desautorizada] Cuando los detalles de autenticación son inválidos o no son otorgados. También útil para disparar un popup de autorización si la API es usada desde un navegador.
  • 403Forbidden – [Prohibida] Cuando la autenticación es exitosa pero el usuario no tiene permiso al recurso en cuestión.
  • 404Not Found – [No encontrada] Cuando un recurso no existente es solicitado.
  • 405Method Not Allowed – [Método no permitido] Cuando un método HTTP que está siendo pedido no está permitido para el usuario autenticado.
  • 410Gone – [Retirado] Indica que el recurso en ese endpoint ya no está disponible. Útil como una respuesta en blanco para viejas versiones de la API
  • 415Unsupported Media Type – [Tipo de contenido no soportado] Si el tipo de contenido que solicita la petición es incorrecto
  • 422Unprocessable Entity – [Entidad improcesable] Utilizada para errores de validación
  • 429Too Many Requests – [Demasiadas peticiones] Cuando una petición es rechazada debido a la tasa límite .

Todas las excepciones y errores deberán mapearse en un payload de eroor

{
"message": "Sorry, the requested resource does not exist",
"code": 34
}