Laravel 10 入門トップページ


目次

  1. API とプロジェクトの概要
  2. プロジェクトの作成と初期設定
  3. データベースのマイグレーション
  4. シーダによるコメントデータの登録
  5. モデルの生成
  6. リソースの生成
  7. GETメソッドを利用した個別コメント取得のAPI作成
  8. 日本語文字列の表示と日時の調整
  9. GETメソッドを利用したコメント一覧取得のAPI作成
  10. データのラップ
  11. POSTメソッドを利用したコメントの新規投稿APIの作成
  12. PUTメソッドを利用したコメント更新APIの作成
  13. DELETEメソッドを利用したコメント削除APIの作成
  14. シーダの拡張
  15. ページネーションの実装
  16. 個別コメントをコントローラで取得
  17. Postman の利用
  18. ユーザ情報を登録する
  19. Sanctum によるユーザ認証
  20. ログインとトークン
  21. コメントとユーザのリレーションシップ
  22. 新規投稿時にユーザIDを記録する
  23. コメントからユーザ名を表示するリレーションシップ
  24. ユーザからコメント一覧を取得するリレーションシップ
  25. 更新と削除の権限設定
  26. 発行済みトークンの取得
  27. トークンの有効期限
  28. レート制限
  29. 閲覧権限の緩和

Laravel で API を開発する

コメントからユーザ名を表示するリレーションシップ

前のページではリソースを編集してコメントを投稿したユーザの ID を表示することができました.ここでは,ユーザ ID の代わりにユーザ名をリレーションシップから辿って取得し,表示する様に変更します.

以前のページではデータベースのマイグレーションにリレーションシップを設定しました.次のとおりモデルファイルにも設定することでリレーションシップを辿ってコメントのオブジェクトからその投稿ユーザオブジェクトを取得できるようになります.リレーションシップの詳細はこちらを参照してください.

app/Models/Comment.php<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Comment extends Model
{
    use HasFactory;

    // One to Many の Many 側
    public function user()
    {
        return $this->belongsTo('App\Models\User');
    }
}

モデルでリレーションシップを設定できたので,リソースを編集してコメントを投稿したユーザのユーザ名が表示されるようにします.

app/Http/Resources/CommentResource.php (抜粋)    /**
     * Transform the resource into an array.
     *
     * @return array<string, mixed>
     */
    public function toArray(Request $request): array
    {
        // return parent::toArray($request);
        return [
            'id' => $this->id,
            'title' => $this->title,
            'body' => $this->body,
            'owner' => $this->user->name,
            'updated_at' => $this->updated_at->addHours(Carbon::now()->offsetHours),
        ];
    }

curl コマンドを使ってコメント情報を取得すると,リソースで設定したとおり,投稿ユーザのユーザ名が表示されました.

C:\Users\Rinsaka>curl -H "Authorization: Bearer 1|fzYV0EEfaDBGy5sifY9V3A6LWZBPmZklpWy4Auxd018912e0" http://192.168.56.101:8000/api/comments/1/ ⏎
{"comment":{"id":1,"title":"最初のコメント","body":"最初のコメントです!","owner":"A. Sample","updated_at":"2023-10-02T10:10:10.000000Z"}}
C:\Users\Rinsaka>curl -H "Authorization: Bearer 1|fzYV0EEfaDBGy5sifY9V3A6LWZBPmZklpWy4Auxd018912e0" http://192.168.56.101:8000/api/comments/2/ ⏎
{"comment":{"id":2,"title":"2つ目","body":"2つ目のコメントです!","owner":"B. Sample","updated_at":"2023-10-02T10:20:10.000000Z"}}
C:\Users\Rinsaka>curl -H "Authorization: Bearer 1|fzYV0EEfaDBGy5sifY9V3A6LWZBPmZklpWy4Auxd018912e0" http://192.168.56.101:8000/api/comments/3/ ⏎
{"comment":{"id":3,"title":"<三個目>のコメント","body":"シーダによってテストデータを設定します.","owner":"A. Sample","updated_at":"2023-10-02T10:30:10.000000Z"}}
C:\Users\Rinsaka>curl -H "Authorization: Bearer 1|fzYV0EEfaDBGy5sifY9V3A6LWZBPmZklpWy4Auxd018912e0" http://192.168.56.101:8000/api/comments/6/ ⏎
{"comment":{"id":6,"title":"渡辺 七夏","body":"2755458  富山県田辺市中央区若松町宇野5-2-8 コーポ佐々木102号 \/ akira43@example.org","owner":"C. Sample","updated_at":"2023-11-24T05:12:28.000000Z"}}
C:\Users\Rinsaka>

目次に戻る