Как правильно отдавать ответ из методов контроллера по методологии REST API?

Question

[Eternal97]

Доброго времени суток. После прочтения множества статей по REST Api на Laravel, появилась путаница в голове. Помогите пожалуйста разъяснить один вопрос. Допустим у меня есть сущность User и я хочу получить, удалить или обновить сущность в бд с помощью методов update и destroy в контроллере. Во всех статьях написано, что метод контроллера отдает ответ в формате JSON. Пример:

public function index()
    {
        $users = User::all();
        return response()->json($users, 200);
    }

public function update(UserRequest $request, $id)
     {
         $user = User::findOrFail($id);
         $user->fill($request->except(['user_id']));
         $user->save();
         return response()->json($user);
     }

public function destroy(UserRequest $request, $id)
     {
         $user = User::findOrFail($id);
         if($user->delete()) return response(null, 204);
     }

Вопрос таков, обязательно ли отдавать JSON и ответы сервера 200, 204, 404 и если обязательно, то как передать JSON во вьюшку, или я могу сделать это так :

public function index()
    {
        $users = User::all();
        return view('userlist', compact('users')):
    }

public function update(UserRequest $request, $id)
     {
         $user = User::findOrFail($id);
         $user->fill($request->except(['user_id']));
         $user->save();
         return redirect()->route('userlist');
     }

public function destroy(UserRequest $request, $id)
     {
         $user = User::findOrFail($id);
         return redirect()->route('userlist');
     }

И если я сделаю так будет ли это считаться REST Api?
Спасибо!

Comments

[JhaoDa]

Так же, как и не в ларавел.

Answer 1

[Алексей Уколов]

обязательно ли отдавать JSON и ответы сервера 200, 204, 404

Полиция REST вас не арестует, конечно. Но это общепринятые соглашения. Потому что...

будет ли это считаться REST Api

...скорее всего - нет. Потому что вы будете отдавать данные, смешанные с представлением. И чтобы, получив список сущностей, фронтенд мог запросить по одной из них детальную информацию, ему нужно будет сначала из вёрстки выковырять её идентификатор.

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

Comments

[Eternal97]

тогда как мне правильно передавать данные во вью и редиректить?

[Алексей Уколов]

Зачем вам передавать данные во вью и редиректить?

[Eternal97]

я пишу тестовое задание: RestAPI (перечень методов которые необходимо реализовать):
-Регистрация / Авторизация;
-Создать/Удалить чек лист (учитывать настройки возможного кол-ва);
-Добавить/Удалить пункт в чек лист;
-Отметить выполнен/не выполнен пункт;
-Получить список чек листов;
-Получить список пунктов чеклиста с указанием выполнен/не выполнен.
Если опираться на методологию REST Api все эти методы будут отдавать JSON, но смотря на условие тестового задания мне еще нужно этот JSON как то передавать в представление, или я ошибаюсь ?

[Алексей Уколов]

Да нет, я не вижу тут ничего про представление.

[Vitsliputsli]

Eternal97,

Если опираться на методологию REST Api все эти методы будут отдавать JSON, но смотря на условие тестового задания мне еще нужно этот JSON как то передавать в представление, или я ошибаюсь ?

Нужно - передавайте. REST ничего не говорит о формате в котором нужно обмениваться данными, но сервер должен отдавать данные универсально, не "прогибаясь" под нужды вывода данных отдельных клиентов. Нужен json - отдавайте json, xml - отдавайте xml.
Если брать внутренности, то принято использовать MVC, если говорить про REST, то представление в нем будет в виде преобразования объекта полученного от модели в json, или xml. Например, у вас может быть 2 представления: отдавать данные в json, отдавать данные в xml.