Как правильно возвращать JSON с контроллеров Laravel для API приложения?

Question

[Vasyl Fomin]

Разрабатываю приложения с RESTFull API на Laravel. Посоветуйте, как правильнее будет реализовать форматирование и возврат данных в JSON формате с контроллеров Laravel ?
В большинстве обучающих примеров, которые я видел, возвращалась просто модель:

public function show($id)
{
   $post =  \App\Models\Post::findOrFail($id);
   return $post;
}

В результате на фронте получаем JSON-массив:

{
    "id": 1,
    "name": "Пример статьи",
    "slug": "primer,
    "body":"",
    "category_id":1
    "created_at": "2017-08-23 14:26:41",
    "updated_at": "2017-08-23 14:26:41",
    "deleted_at": null,  
}

Еще делают так:

public function create(Request $request)
{
   //...
   return response()->json(['success' => true, 'data' = 'Данные успешно сохранены']);
}

Проблемы и вопросы при таком подходе:
1. В большинстве случаев, на фронтенде нам не надо показывать всех полей таблицы (category_id, updated_at, deleted_at,...). Каждый раз вручную массив в каждом контроллере, мне кажется не совсем будет правильно...
2. А что, если нам нужно, например к статьям вытянуть все комментарии (только также без лишних полей)
3. Нужно вытянуть все категории -> их статьи -> их комментарии
4. Нужно определенные поля вывести в определенном формате, например дату.

Для работы с данными использую паттерн "репозиторий". На фронтенде, пока что планируется, сайт на vue.js.

Может кто-то использует пакет spatie/laravel-fractal , какие будут отзывы, рекомендации.

Хотелось бы увидеть хорошие примере разработки таких систем и какие инструменты там используются.

Answer 1

[Alex Wells]

Использую laravel-fractal. В последней версии league/fractal, на основе которого и построен spatie/fractalistic, добавили тип primitive и все стало на свои места.

Конечно, не обошлось без танцев с бубном: я сделал для нужных моделей трейт Transform, который добавляет метод toApi (хотя лучше бы назвал transform), берущий класс из переменной $transformer:

И пришлось написать макрос для collection ларавельной, тоже toApi(). Хотя без обеих этих фич можно обойтись, используя fractal($items, $transformer).

В остальном же полностью доволен.

Comments

[Vasyl Fomin]

Спасибо! Наверное буду использовать фрактал.
И еще вопрос по этому пакету: нужно сформировать с помощью этого пакета (рекурсивно) выпадающее меню. Сейчас без пакета массив имеет такой вид:

У меня есть модель Menu, в которой есть поля: id, name, slug, parent_id
В модели Menu использую

protected $with = ['childs']; //чтобы при получении любого экземпляра, тянулись его дети

и связь

public function childs()
    {
        return $this->hasMany(Menu::class, 'parent_id');
    }

Не подскажете, как такое сформировать в классе трансформере?
Пробивал использовать в классе-трансформере метод

public function includeChilds(Menu $term)
    {
        $childs = $menu->childs;
        return $this->collection($childs, new MenuTransformer());
    }

но таким способом тянуться только родители и их дети, а дети детей нет и т.д - нет.(

[Alex Wells]

Vasyl Fomin: Легко. Если у вас $with всегда заполнен childs, то можно в трансформер добавить
protected $defaultIncludes = ['childs'];
и все =)

[Vasyl Fomin]

Alex Wells: Да, то что надо). Осталось только убрать при выводе элементов подменю, атрибут data

public function includeChilds(Menu $menu)
    {
        $childs = $menu->childs;
        return $this->collection($childs, new MenuTransformer());
    }

Пробивал добавить

//...
return $this->collection($childs, new MenuTransformer())->serializeWith(new ArraySerializer());
//..

но так ошибка - нет такого метода (Call to undefined method League\Fractal\Resource\Collection::serializeWith())

[Alex Wells]

Vasyl Fomin: Публикуете конфиг, создаете класс MyArraySerializer, наследующий ArraySerializer, или как захотите и перезаписываете два метода:

/**
	 * Serialize a collection.
	 *
	 * @param string $resourceKey
	 * @param array $data
	 *
	 * @return array
	 */
	public function collection($resourceKey, array $data)
	{
		return $resourceKey ? [$resourceKey => $data] : $data;
	}

	/**
	 * Serialize an item.
	 *
	 * @param string $resourceKey
	 * @param array $data
	 *
	 * @return array
	 */
	public function item($resourceKey, array $data)
	{
		return $resourceKey ? [$resourceKey => $data] : $data;
	}

Answer 2

[Константин Б.]

1. Для того чтобы какие-то поля модели не отображались нужно использовать переменную hidden, с помощью нее мы указываем какие поля не должны отображаться в JSON ответе.

protected $hidden = [
        'type_id',
        'created_at',
        'updated_at',
    ];

2. У каждой модели вы должны указать свои поля которые должны быть скрыты

protected $hidden = [
        'type_id',
        'created_at',
        'updated_at',
    ];

3. Category::with('posts.comments')->get();
4. Для этого также есть специальные переменные и методы.
Также доступен такой метод

public function getDateAttribute () {
        return date('Y-M-D', $this->date);
    }
public function getUrlAttribute () {
        return url($this->slug);
    }

этот метод выведет $post->date в нужном формате
чтобы такой метод был доступен в json нужно указать его в

protected $appends = [
        'url',
        'topic',
    ];

Answer 3

[artemmityushov]

Оба предложенных варианта имеют свои плюсы и минусы. Добавил бы 3 вариант вывода через Formatters, мы его в основном используем, как минимум чтобы точно контролировать что приходит на апи.

Comments

[Vasyl Fomin]

Formatters - это пакет или какая-то технология в Laravel?

[artemmityushov]

Vasyl Fomin: технология в самом Laravel