Архитектура API на Laravel?

Question

[Muhammad]

Здравствуйте. Делаю небольшое API для AJAX-запросов. Сам роут для API выглядит вот так:

Route::group(array('prefix' => 'api'), function()
{
	Route::any('/v{version}/{group}.{method}.{type?}', 'ApiController@callMethod');
});

Я создал новый неймспейс и прописал в контроллере:

public function callMethod($version, $controller, $method, $responseType =  'json')
{
	$api = new Api\Api();

	return $api->callMethod($controller, $method, $responseType);
}

Все ок пока я не захочу создать новую версию API, сохранив старую. Думал сделать так:

public function callMethod($version, $controller, $method, $responseType =  'json')
{
	$directory = 'v' . $version;
	$className = "Api\\$directory\\Api()";

	$api = new $className();

	return $api->callMethod($controller, $method, $responseType);;
}

и создавать для каждой версии отдельную папку. Но в таком случае придется менять неймспейсы во всех классах, что, как мне кажется, не совсем правильно. Может быть есть другой вариант?

Answer 1

[Сергей Протько]

Может быть есть другой вариант?

Да, есть, перестать страдать фигней с универсальными настройками раутинга (всеравно придется потом что-то докручивать) и сделать нормальную REST/JSON RPC API, со своими правилами на каждый метод API.

laravel.com/docs/5.0/controllers#restful-resource-... - вообще имеет смысл вот такие штуки использовать.

По версиям API - можно через мидлвэры разруливать.

Что до {type} - вообще это не круто, если вы хотите получить json вместо xml, то просто пишите в Accept именно application/json, а не делайте кастыли в URI. Хотя это как вам удобнее конечно.

Comments

[Muhammad]

Спасибо за ответ. Можно подробнее про версионирование?

[Сергей Протько]

Muhammad: ну полностью дублировать контроллер при изменении версии это как-то не круто, хоть и можно. Но тогда контроллеры должны быть ооочень тонкими. Можно просто добавлять методы для каждой новой версии и как-то на мидлвэрах пробовать ресолвить. Мол....

Если мы обращаемся к API с версией 3, то смотреть, если у нас есть метод контроллера saveEntity и метод saveEntityv3, то вызывать второй. Ну мол менять то что наресолвил нам ларавель. Или по аннотациям/настройками дополнительным маршрутизации но это сложнее, зато круче.

[Muhammad]

Сергей Протько: забыл сказать, что у меня версия 4.2. Вариант с методами saveEntityv3 не совсем то. Контроллеры небольшие, поэтому и была идея разбить все по папкам. Придется подумать еще

[Сергей Протько]

Muhammad: ну идея в общем-то простая. Я обычно делаю как, у меня есть надстройка над Symfony/routing (я работаю с Symfony и там это все делается на ивентах, у вас же есть мидлвэры), которая помимо URI и метода запроса учитывает еще и версию (прописывается в настройках маршрутизации). Это позволяет более гибко задавать правила маршрутизации и не особо парится по поводу каких-то вещей.

Далее мы просто в контроллере формируем DTO из той версии что у нас есть под наше приложение, которое и знать ничего не знает о версионизации какой-то. Ну и затем мы получаем опять же из сервиса какое-то DTO и формируем ответ.

[Muhammad]

Сергей Протько: решил проблему