Vue + Vue Router + Vuex + Laravelで写真共有アプリを作ろう (11) 写真一覧取得API

{
  "total": 50,
  "per_page": 15,
  "current_page": 1,
  "last_page": 4,
  "first_page_url": "http://laravel.app?page=1",
  "last_page_url": "http://laravel.app?page=4",
  "next_page_url": "http://laravel.app?page=2",
  "prev_page_url": null,
  "path": "http://laravel.app",
  "from": 1,
  "to": 15,
  "data": [
    {
      "id": "abcd1234EFGH",
      "url": "https://s3-ap-northeast-1.amazonaws.com/backet-name/abcd1234EFGH.jpeg",
      "owner": {
        "name": "John Lennon"
      }
    },
    {
      "id": "ijkl5678MNOP",
      "url": "https://s3-ap-northeast-1.amazonaws.com/backet-name/ijkl5678MNOP.jpeg",
      "owner": {
        "name": "Paul McCartney"
      }
    }
  ]
}

$ php artisan make:factory PhotoFactory

<?php

/** @var \Illuminate\Database\Eloquent\Factory $factory */

use Faker\Generator as Faker;
use Illuminate\Support\Str;

$factory->define(App\Photo::class, function (Faker $faker) {
    return [
        'id' => Str::random(12),
        'user_id' => fn() => factory(App\User::class)->create()->id,
        'filename' => Str::random(12) . '.jpg',
        'created_at' => $faker->dateTime(),
        'updated_at' => $faker->dateTime(),
    ];
});

$ php artisan make:test PhotoListApiTest

<?php

namespace Tests\Feature;

use App\Photo;
use App\User;
use Tests\TestCase;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Carbon\Carbon;
use Illuminate\Support\Facades\DB;

class PhotoListApiTest extends TestCase
{
    use RefreshDatabase;

    /**
     * @test
     */
    public function should_正しい構造のJSONを返却する()
    {
        // 5つの写真データを生成する
        factory(Photo::class, 5)->create();

        $response = $this->json('GET', route('photo.index'));

        // 生成した写真データを作成日降順で取得
        $photos = Photo::with(['owner'])->orderBy('created_at', 'desc')->get();

        // data項目の期待値
        $expected_data = $photos->map(function ($photo) {
            return [
                'id' => $photo->id,
                'url' => $photo->url,
                'owner' => [
                    'name' => $photo->owner->name,
                ],
            ];
        })
        ->all();

        $response->assertStatus(200)
            // レスポンスJSONのdata項目に含まれる要素が5つであること
            ->assertJsonCount(5, 'data')
            // レスポンスJSONのdata項目が期待値と合致すること
            ->assertJsonFragment([
                "data" => $expected_data,
            ]);
    }
}

// 写真一覧
Route::get('/photos', 'PhotoController@index')->name('photo.index');

/**
 * リレーションシップ - usersテーブル
 * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
 */
public function owner()
{
    return $this->belongsTo('App\User', 'user_id', 'id', 'users');
}

/**
 * アクセサ - url
 * @return string
 */
public function getUrlAttribute()
{
    return Storage::cloud()->url($this->attributes['filename']);
}

/** JSONに含める属性 */
protected $appends = [
    'url',
];

class SampleController extends Controller
{
    public function sample()
    {
        $item = Item::first();

        return $item;
    }
}

/** JSONに含めない属性 */
protected $hidden = [
    'user_id', 'filename',
    self::CREATED_AT, self::UPDATED_AT,
];

/** JSONに含める属性 */
protected $visible = [
    'id', 'owner', 'url',
];

protected $visible = [
    'name',
];

protected $hidden = [
    'id', 'email', 'email_verified_at', 'password', 'remember_token',
    self::CREATED_AT, self::UPDATED_AT,
];

/**
 * 写真一覧
 */
public function index()
{
    $photos = Photo::with(['owner'])
        ->orderBy(Photo::CREATED_AT, 'desc')->paginate();

    return $photos;
}

$photos = Photo::all();
foreach ($photos as $photo) {
    var_dump($photo->owner->name);
}

SELECT * FROM `photos`;
SELECT * FROM `users` WHERE `id` = 1;
SELECT * FROM `users` WHERE `id` = 2;
SELECT * FROM `users` WHERE `id` = 3;

$photos = Photo::with(['owner'])->get();
foreach ($photos as $photo) {
    var_dump($photo->owner->name);
}

SELECT * FROM `photos`;
SELECT * FROM `users` WHERE `id` IN (1, 2, 3);

/api/photos/?page=2

public function __construct()
{
    // 認証が必要
    $this->middleware('auth')->except(['index']);
}

$ ./vendor/bin/phpunit --testdox

// 写真ダウンロード
Route::get('/photos/{photo}/download', 'PhotoController@download');

public function __construct()
{
    // 認証が必要
    $this->middleware('auth')->except(['index', 'download']);
}

/**
 * 写真ダウンロード
 * @param Photo $photo
 * @return \Illuminate\Http\Response
 */
public function download(Photo $photo)
{
    // 写真の存在チェック
    if (! Storage::cloud()->exists($photo->filename)) {
        abort(404);
    }

    $disposition = 'attachment; filename="' . $photo->filename . '"';
    $headers = [
        'Content-Type' => 'application/octet-stream',
        'Content-Disposition' => $disposition,
    ];

    return response(Storage::cloud()->get($photo->filename), 200, $headers);
}