JsonResponseTrait
trait JsonResponseTrait (View source)
Trait JsonResponseTrait.
Provides standardized JSON API responses with consistent structure and appropriate HTTP status codes.
This trait is intended for use in controllers or services that return JSON-based API responses. It helps to ensure predictable formatting for both success and error responses.
Methods
Return a 200 OK JSON response.
Return a 201 Created JSON response.
Return a 202 Accepted JSON response (request accepted for processing).
Return a 204 No Content JSON response.
Return a 205 Reset Content JSON response.
Return a 400 Bad Request JSON response.
Return a 401 Unauthorized JSON response.
Return a 403 Forbidden JSON response.
Return a 404 Not Found JSON response.
Return a 409 Conflict JSON response.
Return a 422 Unprocessable Entity JSON response for validation errors.
Return a 429 Too Many Requests JSON response.
Return a 500 Internal Server Error JSON response.
Details
protected JsonResponse
successResponse(array $data = [])
Return a 200 OK JSON response.
protected JsonResponse
createdResponse(array $data = [])
Return a 201 Created JSON response.
protected JsonResponse
acceptedResponse()
Return a 202 Accepted JSON response (request accepted for processing).
protected JsonResponse
noContentResponse()
Return a 204 No Content JSON response.
protected JsonResponse
resetContentResponse()
Return a 205 Reset Content JSON response.
protected JsonResponse
badRequestResponse(array $errors)
Return a 400 Bad Request JSON response.
protected JsonResponse
unauthorizedResponse(string $message = 'Não autorizado.')
Return a 401 Unauthorized JSON response.
protected JsonResponse
forbiddenResponse(string $message = 'Acesso negado.')
Return a 403 Forbidden JSON response.
protected JsonResponse
notFoundResponse(string $message = 'Recurso não encontrado.')
Return a 404 Not Found JSON response.
protected JsonResponse
conflictResponse(array $errors)
Return a 409 Conflict JSON response.
protected JsonResponse
validationErrorResponse(array $errors)
Return a 422 Unprocessable Entity JSON response for validation errors.
protected JsonResponse
tooManyRequestsResponse(string $message = 'Muitas requisições. Tente novamente mais tarde.')
Return a 429 Too Many Requests JSON response.
protected JsonResponse
internalErrorResponse(Throwable $e, string $message = 'Erro interno.')
Return a 500 Internal Server Error JSON response.
Logs the exception and returns a standardized JSON error message.