¿Cómo forzar a FormRequest a devolver json en Laravel 5.1?

Estoy usando FormularioSolicitud para validar desde el cual se envía en una llamada API desde la aplicación de mi teléfono inteligente. Entonces, quiero que FormRequest siempre devuelva json cuando falle la validación.

Vi el siguiente código fuente del marco de Laravel, el comportamiento predeterminado de FormRequest es devolver json si el reqeust es Ajax o wantJson.

//IlluminateFoundationHttpFormRequest class
/**
 * Get the proper failed validation response for the request.
 *
 * @param  array  $errors
 * @return SymfonyComponentHttpFoundationResponse
 */
public function response(array $errors)
{
    if ($this->ajax() || $this->wantsJson()) {
        return new JsonResponse($errors, 422);
    }

    return $this->redirector->to($this->getRedirectUrl())
                                    ->withInput($this->except($this->dontFlash))
                                    ->withErrors($errors, $this->errorBag);
}

Sabía que puedo agregar Accept= application/json en el encabezado de la solicitud. FormRequest devolverá json. Pero quiero proporcionar una forma más fácil de solicitar mi API mediante el soporte json de forma predeterminada sin configurar ningún encabezado. Entonces, traté de encontrar algunas opciones para forzar la respuesta json de FormRequest en IlluminateFoundationHttpFormRequest clase. Pero no encontré ninguna opción que sea compatible de forma predeterminada.

Solución 1: Clase abstracta de solicitud de sobrescritura

Traté de sobrescribir la clase abstracta de solicitud de mi aplicación como sigue:

<?php

namespace Laravel5CgHttpRequests;

use IlluminateFoundationHttpFormRequest;
use IlluminateHttpJsonResponse;

abstract class Request extends FormRequest
{
    /**
     * Force response json type when validation fails
     * @var bool
     */
    protected $forceJsonResponse = false;

    /**
     * Get the proper failed validation response for the request.
     *
     * @param  array  $errors
     * @return SymfonyComponentHttpFoundationResponse
     */
    public function response(array $errors)
    {
        if ($this->forceJsonResponse || $this->ajax() || $this->wantsJson()) {
            return new JsonResponse($errors, 422);
        }

        return $this->redirector->to($this->getRedirectUrl())
            ->withInput($this->except($this->dontFlash))
            ->withErrors($errors, $this->errorBag);
    }
}

yo añadí protected $forceJsonResponse = false; para establecer si necesitamos forzar la respuesta json o no. Y, en cada FormRequest que se extiende desde la clase abstracta Request. Yo configuro esa opción.

Por ejemplo: hice un StoreBlogPostRequest y configuré $forceJsoResponse=true para este FormRequest y haz que responda json.

<?php

namespace Laravel5CgHttpRequests;

use Laravel5CgHttpRequestsRequest;

class StoreBlogPostRequest extends Request
{

    /**
     * Force response json type when validation fails
     * @var bool
     */

     protected $forceJsonResponse = true;
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
        ];
    }
}

Solución 2: Agregue un Middleware y fuerce el encabezado de solicitud de cambio

Construyo un middleware como los siguientes:

namespace Laravel5CgHttpMiddleware;

use Closure;
use SymfonyComponentHttpFoundationHeaderBag;

class AddJsonAcceptHeader
{
    /**
     * Add Json HTTP_ACCEPT header for an incoming request.
     *
     * @param  IlluminateHttpRequest  $request
     * @param  Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $request->server->set('HTTP_ACCEPT', 'application/json');
        $request->headers = new HeaderBag($request->server->getHeaders());
        return $next($request);
    }
}

Es trabajo. Pero me pregunto si estas soluciones son buenas. ¿Y hay alguna forma Laravel de ayudarme en esta situación?

Me sorprende por qué esto es tan difícil de hacer en Laravel. Al final, en base a su idea de anular la clase Solicitud, se me ocurrió esto.

app/Http/Requests/ApiRequest.php

<?php

namespace AppHttpRequests;


class ApiRequest extends Request
{
    public function wantsJson()
    {
        return true;
    }
}

Luego, en cada controlador simplemente pase AppHttpRequestsApiRequest

public function index(ApiRequest $request)

Sé que esta publicación es un poco antigua, pero acabo de crear un Middleware que reemplaza el encabezado “Aceptar” de la solicitud con “aplicación/json”. Esto hace que el wantsJson() retorno de función true cuando se usa. (Esto fue probado en Laravel 5.2 pero creo que funciona igual en 5.1)

Así es como lo implementas:

1. Crear el archivo app/Http/Middleware/Jsonify.php

   namespace AppHttpMiddleware;
   
   use Closure;
   
   class Jsonify
   {
   
       /**
        * Change the Request headers to accept "application/json" first
        * in order to make the wantsJson() function return true
        *
        * @param  IlluminateHttpRequest  $request
        * @param  Closure  $next
        * 
        * @return mixed
        */
       public function handle($request, Closure $next)
       {
           $request->headers->set('Accept', 'application/json');
   
           return $next($request);
       }
   }
   

2. Agregue el middleware a su $routeMiddleware mesa de tu app/Http/Kernel.php Archivo

   protected $routeMiddleware = [
       'auth'       => AppHttpMiddlewareAuthenticate::class,
       'guest'      => AppHttpMiddlewareRedirectIfAuthenticated::class,
       'jsonify'    => AppHttpMiddlewareJsonify::class
   ];
   

3. Finalmente úsalo en tu routes.php como lo haría con cualquier middleware. En mi caso se ve así:

   Route::group(['prefix' => 'api/v1', 'middleware' => ['jsonify']], function() {
       // Routes
   });
   

Según la respuesta de ZeroOne, si está utilizando Solicitud de formulario de validación puede anular el método de validación fallida para devolver siempre json en caso de falla de validación.

Lo bueno de esta solución es que no está anulando todas las respuestas para devolver json, sino solo las fallas de validación. Entonces, para todas las demás excepciones de Php, aún verá la página de error amigable de Laravel.

namespace AppHttpRequests;

use IlluminateContractsValidationValidator;
use IlluminateFoundationHttpFormRequest;
use IlluminateHttpExceptionsHttpResponseException;
use SymfonyComponentHttpFoundationResponse;

class InventoryRequest extends FormRequest
{
    protected function failedValidation(Validator $validator)
    {
        throw new HttpResponseException(response($validator->errors(), Response::HTTP_UNPROCESSABLE_ENTITY));
    }
}

si su solicitud tiene X-Request-With: XMLHttpRequest encabezado o aceptar el tipo de contenido como aplicación/json FormRequest devolverá automáticamente una respuesta json que contiene los errores con un estado de 422.

simplemente anulo el failedValidation función

protected function failedValidation(Validator $validator)
{
    if ($this->wantsJson()) {
        throw new HttpResponseException(
            Response::error(__('api.validation_error'), 
            $validator->errors(), 
            470, 
            [], 
            new ValidationException)
        );
    }

    parent::failedValidation($validator);
}

Así que mi muestra de salida personalizada como a continuación:

{
    "error": true,
    "message": "Validation Error",
    "reference": [
        "The device id field is required.",
        "The os version field is required.",
        "The apps version field is required."
    ],
}

Por cierto, Respuesta:: el error no existe en laravel. Estoy usando macroable para crear un nuevo método

 Response::macro('error', function ($msg = 'Something went wrong', $reference = null, $code = 400, array $headers = [], $exception = null) {
      return response()->json(//custom here);
 });