Dingo API удаляет "данные" конверт

есть ли простой способ удалить "данные" из конверта из ответа Dingo API.

Когда я использую этот трансформатор для преобразования пользовательских моделей:

class UserTransformer extends EloquentModelTransformer
{

    /**
     * List of resources possible to include
     *
     * @var array
     */
    protected $availableIncludes = [
        'roles'
    ];

    protected $defaultIncludes = [
        'roles'
    ];

    public function transform($model)
    {
        if(! $model instanceof User)
            throw new InvalidArgumentException($model);

        return [
            'id' => $model->id,
            'name' => $model->name,
            'email' => $model->email
        ];
    }

    /**
     * Include Roles
     *
     * @param User $user
     * @return \League\Fractal\Resource\Item
     */
    public function includeRoles(User $user)
    {
        $roles = $user->roles;

        return $this->collection($roles, new RoleTransformer());
    }

Получаю этот ответ:

{
data : [
      "id": 102,
      "name": "Simo",
      "email": "[email protected]",
      "roles": {
        "data": [
          {
            "id": 1    
            "name": "admin"
          }
        ]
      }
    }
]
}

Я прочитал несколько статей о API RESTful, и многие из них заявили, что такие огибающие ответы являются очень современными (вместо этого вы должны использовать HTTP-заголовок).

Как я могу отключить это поведение, по крайней мере, для включений?

Спасибо

Ответы

Ответ 1

Для тех, кто попадает на это позже, и поскольку мне было очень тяжело это сделать, я хотел бы поделиться тем, как я работал в своем API:

1) Создайте пользовательский сериализатор NoDataArraySerializer.php:

namespace App\Api\V1\Serializers;

use League\Fractal\Serializer\ArraySerializer;

class NoDataArraySerializer extends ArraySerializer
{
    /**
     * Serialize a collection.
     */
    public function collection($resourceKey, array $data)
    {
        return ($resourceKey) ? [ $resourceKey => $data ] : $data;
    }

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

2) Установите новый сериализатор. В bootstrap/app.php добавьте:

$app['Dingo\Api\Transformer\Factory']->setAdapter(function ($app) {
    $fractal = new League\Fractal\Manager;
    $fractal->setSerializer(new App\Api\V1\Serializers\NoDataArraySerializer);
    return new Dingo\Api\Transformer\Adapter\Fractal($fractal);
});

Что это.

Теперь, в вашем UserController (например), вы можете использовать его следующим образом:

namespace App\Api\V1\Controllers;

use App\Api\V1\Models\User;
use App\Api\V1\Transformers\UserTransformer;

class UserController extends Controller
{
    public function index()
    {
        $items = User::all();

        return $this->response->collection($items, new UserTransformer());
    }
}

И ответ будет выглядеть так:

[
    {
        "user_id": 1,
        ...
    },
    {
        "user_id": 2,
        ...
    }
]

Или, я хочу добавить конверт, вам просто нужно установить ключ ресурса в контроллере. Заменить:

return $this->response->collection($items, new UserTransformer());

по

return $this->response->collection($items, new UserTransformer(), ['key' => 'users']);

И ответ будет выглядеть так:

{
    "users": [
        {
            "user_id": 1,
            ...
        },
        {
            "user_id": 2,
            ...
        }
    ]
}

Ответ 3

Одно дополнение к решению YouHieng. Предпочтительный способ регистрации NoDataArraySerializer в Laravel 5.3 и выше - написать пользовательский ServiceProvider и добавить логику в метод boot(), а не файл bootstrap/app.php.

Пример:

php artisan make:provider DingoSerializerProvider

Тогда:

public function boot(){
    $this->app['Dingo\Api\Transformer\Factory']->setAdapter(function ($app) {
        $fractal = new League\Fractal\Manager;
        $fractal->setSerializer(new App\Http\Serializers\NoDataArraySerializer());
        return new Dingo\Api\Transformer\Adapter\Fractal($fractal);
    });
}