Laravel resource controllers for both API and non-API use

Question

After creating a resource controller PhotosController for a website that also does AJAX calls to the API, it appears that the resource controller can be used on both the normal website and as the API.

This displays a HTML page for Photo with id = 1

http://domain.com/photos/1

and Javascript uses the following which updates the Photo resource and returns a JSON response

PUT http://domain.com/api/v1/photos/1

Question: Will we have 2 PhotoControllers, one to handle API usage and one for non-API?

searsaw · Answer 1 · 2013-07-28T13:57:01.133

6

No. You can have two separate routes point to the same controller and action.

Route::get('/photos/1', 'PhotoController@index');
Route::get('/api/v1/photos/1', 'PhotoController@index');

Then, in your controller methods, you can test whether the request is from Ajax or not.

if (Request::ajax()) {
    // Do some crazy Ajax thing
}

edited Jul 28 '13 at 13:57

answered Jul 27 '13 at 16:00

searsaw

3,492
24
31

1

Why do you include the domain? To me, that's a DRY issue, and somewhat unnecessary... – Mike Rockétt Jul 28 '13 at 06:49
You wouldn't want to. I changed edited my answer. Thanks for pointing that out, @Mike Anthony – searsaw Jul 28 '13 at 13:55

score 2 · Answer 2 · answered Mar 13 '14 at 01:31

I use a route group with prefix for API calls:

Route::resource('venue', 'VenueController');

Route::group(array('prefix' => 'api'), function(){
    Route::resource('venue', 'VenueController', array('only' => array('index', 'show')));
});

Then, in the controller, I use this condition:

if (Route::getCurrentRoute()->getPrefix() == 'api') {
    return Response::json($venues->toArray());
}

Laravel resource controllers for both API and non-API use

2 Answers2

Linked