質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.65%

Laravel Rest API 返却するJSONの形式

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 1,079

aaaegege

score 7

勉強のために、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:
    ・
    ・
    ・
  }
・
・
・
]    
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

0

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);

// 省略

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/09/19 20:45 編集

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

    キャンセル

  • 2018/09/19 20:48

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

    キャンセル

  • 2018/09/19 20:53

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

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.65%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる