Create nested API

Question

I'm trying to make an api that have lists and inside each list there is anther list inside of it called cards and the cards list is the cards of this list.

I tried to show it in index function and didn't work it was like this:

  public function index()
  { 
   // $list = List -> cards();
    $list = List::cards();

    return response( $list );
  }

Card Model:

  public function list()
   {
        return $this->belongsTo( List::class() );
   }

Card Model:

  public function cards()
   {
        return $this->hasMany( Card::class() );
   }

What i want to output is json data like this:

  "lists":[
           'name':listname

             'cards':[
                       'card one': card name,
                     ]
           ]

Mohammad Habibinodeh · Accepted Answer · 2019-06-20 13:27:34Z

1

If you use Laravel framework use Resource for response, in Resource of laravel you can load cards. For example in ListController :

public function index()
{
    return ListResource::collection(List::all()->paginate());
}

And in ListResource :

public function toArray($request)
{
    'cards' => CardResource::collection('cards');
}

answered Jun 20, 2019 at 13:27

Mohammad Habibinodeh

1864 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Vitalii · Accepted Answer · 2019-06-20 13:15:57Z

0

belongsTo or hasMany accepts model name as a first argument. In your case you need to pass your model class name in your relations methods.

public function list()
{
    return $this->belongsTo(List::class);
}

and

public function cards()
{
    return $this->hasMany(Card::class);
}

So if you want to receive models including relations you can use with method.

return response(List::query()->with('cards'));

answered Jun 20, 2019 at 13:15

Vitalii

1,17514 silver badges25 bronze badges

Comments

marv255 · Accepted Answer · 2019-06-20 13:44:50Z

0

You can use resources.

Http\Resources\List:

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class List extends JsonResource
{
    public function toArray($request)
    {
        $cards = [];
        foreach ($this->cards as $card) {
            $cards[] = $card->name;
        }

        return [
            'name' => $this->name,
            'cards' => $cards,
        ];
    }
}

Http\Controllers\ListController:

namespacce App\Http\Controllers;

use App\Http\Resources\List as ListResource;
use App\Components\List;

class ListController extends Controller
{
    $lists = List::query()->get();

    return ListResource::collection($lists)->response();
}

edited Jun 20, 2019 at 13:44

answered Jun 20, 2019 at 13:17

marv255

8166 silver badges21 bronze badges

2 Comments

marv255 Over a year ago

And what does dd($this->cards); in ListResource show?

user8183017 Over a year ago

show 4 cards only the data have 8 cards how is that happen?

Collectives™ on Stack Overflow

Create nested API

3 Answers 3

Comments

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related