Laravel Rest API 返却するJSONの形式

Question

勉強のために、LaravelでRest APIを作成しています。

返却するJSONの形式を下記のように、オブジェクトの中にオブジェクトがあるような形式にしたいのですがどのようにすればよいのでしょうか？
Twitter timelineの例です。

[ {
	created_at:
	id:
	id_str:
	text:
	truncated:
	user:{
		id:
		id_str:
		name:
		screen_name:
    }
    ・
    ・
    ・
  }
・
・
・
]

例えばツイートテーブルとユーザーテーブルを用意するとします。
Rest API準備

Resource Controller
アクセスしたらTweetテーブルから全クエリ取得

class TimelineController extends Controller {
	public function index() {
        $items = Tweet::all();
        
        return  $items;
    }

これでアクセスした場合の返却は、以下のようになると思います。
ここに、ツイートした人の情報を追加したい場合、ユーザーテーブルから取得すると思いますが、
取得後どのように成形すればTwitterのタイムラインのようなJSONの構造にできるのでしょうか。

[ {
	created_at:
	id:
	id_str:
	text:
	truncated:
	・
	・
	・
  }
・
・
・
]	

Answer 1

Resource を使って下さい。

https://readouble.com/laravel/5.6/ja/eloquent-resources.html

以下にサンプルコードを置いておきます。

UserResource

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class UserResource extends JsonResource
{
    /**
     * ユーザResource
     *
     * @param  \Illuminate\Http\Request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created_at' => $this->created_at,
            'updated_at' => $this->updated_at,
        ];
    }
}

TweetResource

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;
use App\Http\Resources\UserResource

class TweetResource extends JsonResource
{
    /**
     * ツイートResource
     *
     * @param  \Illuminate\Http\Request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'text' => $this->text,
            'created_at' => $this->created_at,
            'updated_at' => $this->updated_at,
            'user' => new UserResource($this->user),
        ];
    }
}

TweetController

// 省略

$tweets = Tweet::all();

return TweetResource::collection(tweets);

// 省略

Comments

[aaaegege]

ありがとうございます。
できましたが、data[ ]で囲まれてしまいます。
data: [ {・・・ } ]
これは変えられないのでしょうか？

[退会済みユーザー]

はい、特別な理由がない限り従って下さい。dataの他にmeta情報がありませんか？dataとmetaが混ざらないようにそのような構造になっています。

[aaaegege]

そうなんですね。
ありがとうございました！