How to return an array if the request not passed the middleware in Laravel?

Question

I'm using Laravel for backend and AngularJS for handle the front-end. The problem is the angularjs call ajax to controller to get the data, otherwise the auth middleware, i want to add 1 more middleware called apiKeyAuth to check if end user send request with valid api key. But after i check the conditional inside apiKeyAuth, it give me an error in \Http\Middleware\VerifyCsrfToken.php. The return type of invalid api key is an array. Below is my code.

*APIKeyAuth Middleware:

class APIKeyAuth
{
    public function handle($request, Closure $next)
    {
        if ($request->get('api_key') != 'MyAPIKey'){
            return ['status' => 401, 'message' => 'Invalid API Key.', 'data' => null];
        }
        return $next($request);
    }
}

Mihai Matei · Accepted Answer · 2020-01-17 13:47:14Z

2

You should return a JsonResponse instead of an array:

class APIKeyAuth
{
    public function handle($request, Closure $next)
    {
        if ($request->get('api_key') != 'MyAPIKey'){
            return Illuminate\Http\JsonResponse::create(
                ['message' => 'Invalid API Key.'],
                Illuminate\Http\JsonResponse::HTTP_UNAUTHORIZED
            );
        }
        return $next($request);
    }
}

answered Jan 17, 2020 at 13:47

Mihai Matei

24.3k5 gold badges34 silver badges50 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Patrick Schocke · Accepted Answer · 2020-01-17 14:28:39Z

1

The VerifyCsrfToken middleware checks for a valid csrf token. It runs before your custom middlewares.

By default, your ajax requests don't include an csrf token.

If you make requests from your frontend, simply add a csrf token to your requests. E.g. Axios:

window.axios = require('axios');

window.axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';

let token = document.head.querySelector('meta[name="csrf-token"]');

if (token) {
    window.axios.defaults.headers.common['X-CSRF-TOKEN'] = token.content;
} else {
    console.error('CSRF token not found: https://laravel.com/docs/csrf#csrf-x-csrf-token');
}

If you want to access your api from outside your frontend, consider moving your api routes into the dedicated routes/api.php file or disabling csrf protection on these routes: Docs

namespace App\Http\Middleware;

class VerifyCsrfToken extends Middleware
{
    protected $except = [
        'stripe/*',
        'http://example.com/foo/bar',
        'http://example.com/foo/*',
    ];
}

Also, as @matei-mihai suggested, use JsonResponse to return your array

edited Jan 17, 2020 at 14:28

answered Jan 17, 2020 at 14:22

Patrick Schocke

1,4912 gold badges15 silver badges25 bronze badges

2 Comments

Steven Dang Over a year ago

But i want to be an array to response to my ajax call then i will show the alert, not show new page...@@

Patrick Schocke Over a year ago

Yes, a JsonResponse converts your array to a response. See laravel.com/docs/5.8/responses#json-responses

Collectives™ on Stack Overflow

How to return an array if the request not passed the middleware in Laravel?

2 Answers 2

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related