В каком виде лучше отдавать данные клиенту?

Question

[darksladen]

Подскажите, как правильно возвращать данные клиенту при запросе? Пишу приложение на laravel, но думаю в других фреймворках тоже самое будет. Допустим у меня есть контроллер, в котором есть метод добавления товара в корзину.. Что он должен возвращать клиенту при запросе? Запрос на него будет приходить очевидно через ajax..

У меня пока такие варианты:
- Вернуть json со статусом и ошибками, если они есть и обработать на клиенте
- Возвращать статус ответа, отличимый от 200 (301), если добавление не удалось и обработать на клиенте
- Также можно отдавать вьюшку готовую и отображать в модалке, типа товар успешно добавлен и показать его в модалке к примеру..

Вариантов как то слишком много.. Какой из них лучше, почему и какие еще есть варианты?
Также непонятно, что должен делать такой метод при обычном запросе не через ajax.. Делать редирект на предыдущий урл или корзину например?

Answer 1

[D3lphi]

1) Отдавать нужно json строку с кодом ответа/статусом и тд, чтобы можно было на клиентской стороне обработать ответ и произвести необходимые действия.
2) В контроллере никакую логику не пишем. Она выносится в сервисный слой. (Это я про эту фразу "есть контроллер, в котором есть метод добавления товара в корзину").
3)

Также непонятно, что должен делать такой метод при обычном запросе не через ajax.. Делать редирект на предыдущий урл или корзину например?

Это уже вам решать. Тут все зависит от потребности. Хотя, я бы вообще не стал этот маршрут приспосабливать для "обычного запроса", создал бы другой специально для этого.

Comments

[darksladen]

Спасибо за ответ! Я раньше делал сайты на битриксе и там при добавлении товара в корзину компонент отдавал представление, которое загружалось в fancybox. То есть fancybox делал запрос и показывал в модалке вьюшку которую отдавал сервер. В этой вьюшке могло быть к примеру текущее кол-во товаров и сам товар, добавленный в корзину. Чем плох такой подход?

2) Ну контроллер же в любом случае будет обрабатывать запрос, разве нет? То есть он получит id товара и через модель добавит товар в таблицу корзины. Поправьте, если я не прав..

3) Кстати забыл спросить.. То есть надо делать отдельные маршруты для ajax? Получается метод к примеру addToCart и ajaxAddToCart? Как то так?

[D3lphi]

darksladen: Я бы отдавал данные с сервера, а клиент уже бы сам строил эту самую вьюшку.
2) Нет, вот это распространенное заблуждение. В контроллере не должно быть бизнес логики. Контроллер лишь валидирует данные и вызывает метод класса-сервиса, а тот, в свою очередь, производит всю работу. После, контроллер отдает ответ. Все, на этом его зона ответственности заканчивается. "Напрямую" добавлять товары в таблицу не рекомендуется. Для работы с моделью обычно пишется класс репозиторий, который уже и выполняет работу с данными. В нем так же можно проверять, есть ли данные в кеше и, если нет, делать запрос к хранилищу(БД, например) и вытаскивать данные от туда.
3) Я бы делал так. Вот здесь, как раз - таки, вы и получаете преимущество в использовании сервиса. Логика написана в нем и вы можете вызывать их из любого контроллера, не дублируя код.

[darksladen]

D3lphi: Ну это ясно, что лучше логику выносить в отдельные классы, но в моем вопросе по сути логики нет, есть контроллер, обрабатывающий запрос, но спасибо все равно =) И последний вопрос тогда: если отдавать ajax, то в каком виде отдавать ошибки? Просто код ошибки, а текст уже на фронтенде генерировать или код с текстом сразу? Думаю что с тестом конечно, особенно если сайт мультиязычный..

[D3lphi]

darksladen: Да, с текстом. Сервер будет определять, на каком языке отдать инфо. об ошибке.

[Иван Филатов]

darksladen: не надо делать 100500 маршрутов. Тип отдаваемых данных должен быть конфигурацией. Захотели JSON, захотели XML. Код не знает ничего про формат ответа. Он просто передает модель, дальше middleware преобразует его и отдает непосредственно в браузер.

Answer 2

[Иван Филатов]

1. Если модель переданная в API не будет изменена - то можно отдать Accepted = 202
2. Если подразумевается изменение модели, или хоть одного поля, - то нужно вернуть Ok = 200, в body положить новую модель.

Если ошибки - в любом случае возвращаем код отличный от успешного, в body ложим контракт с данными, чтобы затем обработать.

Comments

[darksladen]

А код ошибки лучше в json отдавать или в http?
И что значит контракт с данными?

[Иван Филатов]

darksladen: JSON конечно.
ну фронтенд должен знать формат ошибки, чтобы понимать какие поля читать.
условно там должны быть поля КодОшибки, ТекстОшибки

КодОшибки не путать в кодом ответа HTTP. Код - это код возможной проблемы, если существует возможность понять причину на стороне сервера. У очень крупных API такое есть.

Answer 3

[Вячеслав Плиско]

Отдавайте разные заголовоки и json с обязательным полем status.
Некоторые устройства криво работают с апи без боди, так что одним заголовком не обойдёшься.