"Get" route with query string and custom params

Question

I am using Laravel 5.5.13.

My goal is to create an endpoint like this:

/api/items/{name}?kind={kind}

Where kind is optional parameter passed in by the query string.

My current routes in api.php looks like this:

Route::get('items', 'DisplaynameController@show');

My current controller is like this:

public function show(Request $request)
{
    if ($request->input('kind') {
        // TODO
    } else {
        return Item::where('name', '=', $request->input('name'))->firstOrFail();
    }
}

I

I am currently using $request->input('name') but this means I need to provide ?name=blah in the query string. I am trying to make it part of the route.

May you please provide guidance.

Kenny Horna · Accepted Answer · 2019-12-11 16:51:53Z

The $name variable is a route param, not a query param, this means that you can pass it directly to the function as an argument.

So, if your route is like this:

Route::get('items/{name}', 'DisplaynameController@show');

Your function should be like this:

public function show(Request $request, $name) // <-- note function signature
{   //                                 ^^^^^
    if ($request->has('kind'))
    {
        // TODO
    }
    else
    {
        return Item::where('name', '=', $name)->firstOrFail(); // <-- using variable
    }   //                              ^^^^^
}

Another option is to get the variable as a Dynamic Property like this:

public function show(Request $request)
{
    if ($request->has('kind'))
    {
        // TODO
    }
    else
    {
        return Item::where('name', '=', $request->name)->firstOrFail();
    }   //                              ^^^^^^^^^^^^^^
}

Notice that we access the name value as a dynamic property of the $request object like this:

$request->name

For more details, check the Routing > Route parameters and Request > Retrieving input sections of the documentation.

Oh interesting, thank you for helping with the docs. The first challenge to learning something new is to learning how to navigate the docs. I really appreciate it. So it is not possible to get query string parmeters auto binded?
@Blagoh for query params not yet, but Laravel can bind route params to match them to models as you can see here. All you need to do is type-hint the request on your controller method.

ka_lin · Accepted Answer · 2017-11-12 21:42:42Z

2

As stated in the documentation you should do:

public function show($name, Request $request)

Laravel will take care of the variable binding

answered Nov 12, 2017 at 21:42

ka_lin

9,4226 gold badges39 silver badges58 bronze badges

1 Comment

Blagoh Over a year ago

Thank you sir. By any chance do you know a better way for me to do the $request->input('kind') check? Is this is the Laravel recommended way?

Collectives™ on Stack Overflow

"Get" route with query string and custom params

2 Answers 2

3 Comments

1 Comment

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

1 Comment

Related