How can I use Laravel Validation in the API, it's returning my view now?

Question

I have this route in route/api.php:

Route::post('/register', 'LoginController@register');

My LoginController

class LoginController extends Controller {

public function register(Request $request) {
    $this->validate($request, // <-- using this will return the view
      // from **web.php** instead of the expected json response.
    [
        'email' => 'required|email',
        'firstName' => 'required|alpha_dash',
        'lastName' => 'required',
        'password' => 'required|confirmed',
    ]);

    $input = $request->all();
    //$plain_password = $input['password'];
    $input['uuid'] = uuid();
    $input['password'] = Hash::make($input['password']);

    $user = User::create($input);

    dd($errors);

    $response['succes'] = true;
    $response['user'] = $user;
    return response($response);
    }
}

Why does adding a validation call change the behaviour to returning my view / the wrong route. I want the api to validate my request too, not just my "frontend".

The Alpha · Accepted Answer · 2017-02-14T23:17:37.430

1

When you use Laravel's validate method from controller it automatically handles/takes the step if the validation fails. So, depending on the required content type/request type, it determines whether to redirect back or to a given url or sending a json response. Ultimately, something like thos following happens when your validation fails:

protected function buildFailedValidationResponse(Request $request, array $errors)
{
    if ($request->expectsJson()) {
        return new JsonResponse($errors, 422);
    }

    return redirect()->to($this->getRedirectUrl())
                    ->withInput($request->input())
                    ->withErrors($errors, $this->errorBag());
}

So, if the first if statement is true then you'll get a json response and it'll be true if you either send an ajax request or if you attach a accept header with your request to accept json response (When requesting from a remote server). So, make sure your request fulfills the requirements.

Alternatively, you can manually validate the request using the Validator component and return a json response explicitly if it fails.

edited Feb 14 '17 at 23:17

answered Feb 14 '17 at 20:12

The Alpha

143,660
29
287
307

So my solution is adding the header: `X-Requested-With: XMLHttpRequest`? When testing this works, but is it also best practice? – online Thomas Feb 14 '17 at 20:43
This is the way it works for `ajax` request in `Symfony Request` so in `Laravel Request`. – The Alpha Feb 14 '17 at 23:07
If it makes sense tho. – The Alpha Feb 14 '17 at 23:09
Hmm well I really don't get why a restful api would return html if the request was not made with xhr but a curl call by default. I like it to be always json :) – online Thomas Feb 14 '17 at 23:11
Most javascript libraries/frameworks sends the header (`X-Requested-With`) transparently so you don't need to add this manually when sending ajax request. – The Alpha Feb 14 '17 at 23:11
Actually it should be `accept` header when requesting from a remote server. – The Alpha Feb 14 '17 at 23:18
Let's try that tomorrow – online Thomas Feb 14 '17 at 23:19
I'd say related: http://stackoverflow.com/questions/31507849/how-to-force-formrequest-return-json-in-laravel-5-1 – online Thomas Feb 15 '17 at 09:01

How can I use Laravel Validation in the API, it's returning my view now?

1 Answers1