Laravel API APP 多对多关系，如何返回 JSON 中的具体信息？

Question

我已经尝试解决这个问题一段时间了。基本上我有 2 个模型 'Recipe'、' Ingredient' 和一个 Controller 'RecipeController'。 我正在使用 Postman 来测试我的 API。当我转到使用 RecipeController@getRecipe 的 get 路线时，返回值如下图所示：

Return for Get Route

如果我希望 get 路由的返回值采用下图的格式，我该如何实现？我的意思是我不想看到食谱：created_at 列、updated_at 列和成分：pivot 信息列，只想要名称和数量列信息。

Return Value Format I Want

配方模型：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Recipe extends Model
{
    protected $fillable = ['name', 'description'];

    public function ingredients()
    {
      return $this->belongsToMany(Ingredient::class, 
      'ingredient_recipes')->select(array('name', 'amount'));
    }
}

成分模型：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Ingredient extends Model
{
    protected $fillable = ['name', 'amount'];
}

配方控制器

<?php

namespace App\Http\Controllers;


use App\Ingredient;
use App\Recipe;
use Illuminate\Http\Request;

class RecipeController extends Controller {

public function postRecipe(Request $request)
{
    $recipe = new Recipe();
    $recipe->name = $request->input('name');
    $recipe->description = $request->input('description');
    $recipe->save();

    $array_ingredients = $request->input('ingredients');
    foreach ($array_ingredients as $array_ingredient) {
        $ingredient = new Ingredient();
        $ingredient->name = $array_ingredient['ingredient_name'];
        $ingredient->amount = $array_ingredient['ingredient_amount'];
        $ingredient->save();
        $recipe->ingredients()->attach($ingredient->id);
    }

    return response()->json(['recipe' => $recipe . $ingredient], 201);
}

public function getRecipe()
{
    $recipes = Recipe::all();
    foreach ($recipes as $recipe) {
        $recipe = $recipe->ingredients;
    }
    $response = [
        'recipes' => $recipes
    ];
    return response()->json($response, 200);
}

API 路由：

Route::post('/recipe', 'RecipeController@postRecipe')->name('get_recipe');
Route::get('/recipe', 'RecipeController@getRecipe')->name('post_recipe');

谢谢各位！

Answer 1

我认为您最好的解决方案是使用 Transformer。使用您当前的实现，我建议仅在循环中获取所需的字段，即：

foreach ($recipes as $recipe) {
    $recipe = $recipe->ingredients->only(['ingredient_name', 'ingredient_amount']);
}

虽然上述方法可能有效，但您当前的实现存在问题，因为将有大量的迭代/循环轮询数据库，我建议改为预先加载关系。 但是为了这个问题，你只需要Transformer。

使用composer安装transformer composer require league/fractal 然后就可以在app目录下创建一个名为Transformers的目录。

然后创建一个名为 RecipesTransformer 的类，并使用以下命令进行初始化：

namespace App\Transformers;

use App\Recipe;

use League\Fractal\TransformerAbstract;

class RecipesTransformer extends TransformerAbstract
{
    public function transform(Recipe $recipe)
    {
        return [
            'name' => $recipe->name,
            'description' => $recipe->description,
            'ingredients' => 
                $recipe->ingredients->get(['ingredient_name', 'ingredient_amount'])->toArray()
        ];
    }
}

然后你可以像这样在你的控制器方法中使用这个转换器：

use App\Transformers\RecipesTransformer;
......
public function getRecipe()
{
     return $this->collection(Recipe::all(), new RecipesTransformer);
     //or if you need to get one
     return $this->item(Recipe::first(), new RecipesTransformer);
}

你可以参考一个很好的教程like this以获得更多灵感，或者直接去Fractal's page了解详情。

更新

如果您的项目中有 Dingo API，为了让 Fractal 集合正常工作，因为如果您的项目中有 Dingo API，我给出的示例将起作用，您可以通过这种方式手动创建它：

public function getRecipe()
{
    $fractal = app()->make('League\Fractal\Manager');
    $resource = new \League\Fractal\Resource\Collection(Recipe::all(), new RecipesTransformer);

     return response()->json(
        $fractal->createData($resource)->toArray());
}

如果你想创建一个项目而不是集合，那么你可以使用new \League\Fractal\Resource\Item 来代替。我建议您安装 Dingo API，或者您可以关注this simple tutorial，以便在没有不必要的重复的情况下更整洁地处理