LaravelでCRUD APIを作成する

1
<?php
2
use Illuminate\Support\Facades\Schema;
3
use Illuminate\Database\Schema\Blueprint;
4
use Illuminate\Database\Migrations\Migration;
5

6
class CreateTasksTable extends Migration
7
{
8
  public function up()
9
  {
10
    Schema::create('tasks', function (Blueprint $table) {
11
      $table->increments('id');
12
      $table->string('title');
13
      $table->integer('state_id')->unsigned()->default(1);
14
      $table->integer('user_id')->references('id')->on('users')->unsigned()->index()->nullable();
15
      $table->timestamp('due_at')->nullable()->comment('期日');
16
      $table->timestamps();
17
    });
18
  }
19

20
  public function down()
21
  {
22
    Schema::dropIfExists('tasks');
23
  }
24
}

1
<?php
2
use Illuminate\Database\Seeder;
3

4
class TasksTableSeeder extends Seeder
5
{
6
  public function run()
7
  {
8
    DB::table('tasks')->insert([
9
      [
10
        'title' => 'はじめてのタスク',
11
        'state_id' => 1,
12
        'user_id' => 1,
13
        'due_at' => '2018-10-02 14:28:19',
14
        'created_at' => '2018-10-02 14:28:19',
15
        'updated_at' => '2018-10-02 14:28:19'
16
      ],[
17
        'title' => '2番目のタスク',
18
        'state_id' => 2,
19
        'user_id' => 1,
20
        'due_at' => '',
21
        'created_at' => '2018-10-04 14:28:19',
22
        'updated_at' => '2018-10-04 14:28:19'
23
      ]
24
    ]);
25
  }
26
}

1
public function run()
2
{
3
  $this->call(UsersTableSeeder::class);
4
  $this->call(TasksTableSeeder::class);
5
}

1
<?php
2
namespace App\Models;
3

4
use Illuminate\Database\Eloquent\Model;
5

6
class Task extends Model
7
{
8
  /**
9
  * @var array
10
  */
11
  protected $fillable = [
12
    'title', 'state_id', 'user_id', 'due_at'
13
  ];
14
}

1
<?php
2
namespace App\Repositories;
3

4
use Illuminate\Database\Eloquent\Model;
5

6
class Repository
7
{
8
  /**
9
  * @var Model
10
  */
11
  protected $model;
12

13
  /**
14
  * @param Model $model
15
  */
16
  public function __construct(Model $model)
17
  {
18
    $this->model = $model;
19
  }
20

21
  /**
22
  * @return \Illuminate\Database\Eloquent\Collection
23
  */
24
  public function all()
25
  {
26
    return $this->model->all();
27
  }
28

29
  /**
30
  * @param array $data
31
  * @return mixed
32
  */
33
  public function store(array $data)
34
  {
35
    return $this->model->create($data);
36
  }
37

38
  /**
39
  * @param array $data
40
  * @param int $id
41
  * @return mixed
42
  */
43
  public function update(array $data, int $id)
44
  {
45
    $record = $this->model->find($id);
46
    return $record->update($data);
47
  }
48

49
  /**
50
  * @param int $id
51
  * @return int
52
  */
53
  public function delete(int $id)
54
  {
55
    return $this->model->destroy($id);
56
  }
57

58
  /**
59
  * @param int $id
60
  * @return mixed
61
  */
62
  public function findById(int $id)
63
  {
64
    return $this->model->findOrFail($id);
65
  }
66
}

1
<?php
2
namespace App\Http\Requests;
3

4
use Illuminate\Foundation\Http\FormRequest;
5

6
class TaskRequest extends FormRequest
7
{
8
  /**
9
  * @return bool
10
  */
11
  public function authorize()
12
  {
13
    return true;
14
  }
15

16
  /**
17
  * @return array
18
  */
19
  public function rules()
20
  {
21
    return [
22
      'title' => 'required'
23
    ];
24
  }
25

26
  /**
27
  * @return array
28
  */
29
  public function messages()
30
  {
31
    return [
32
      'title.required' => 'タイトルは必ず入力してください。',
33
    ];
34
  }
35
}

1
<?php
2
namespace App\Http\Controllers;
3

4
use App\Models\Task;
5
use App\Repositories\Repository;
6
use App\Http\Requests\TaskRequest;
7

8
class TasksController extends Controller
9
{
10
  /** @var Repository */
11
  protected $repository;
12

13
  /**
14
  * TasksController constructor.
15
  * @param Task $task
16
  */
17
  public function __construct(Task $task)
18
  {
19
    $this->repository = new Repository($task);
20
  }
21

22
  /**
23
  * @return \Illuminate\Http\JsonResponse
24
  */
25
  public function index()
26
  {
27
    $tasks = $this->repository->all();
28
    return response()->json($tasks);
29
  }
30

31
  /**
32
  * @param $id
33
  * @return \Illuminate\Http\JsonResponse
34
  */
35
  public function show($id)
36
  {
37
    return response()->json($this->repository->findById($id));
38
  }
39

40
  /**
41
  * @param TaskRequest $request
42
  * @return \Illuminate\Http\JsonResponse
43
  */
44
  public function store(TaskRequest $request)
45
  {
46
    $response = $this->repository->store($request->all());
47
    return response()->json($response, 201);
48
  }
49

50
  /**
51
  * @return \Illuminate\Http\JsonResponse
52
  */
53
  public function update(TaskRequest $request, int $id)
54
  {
55
    $response = $this->repository->update($request->all(), $id);
56
    return response()->json($response, 200);
57
  }
58

59
  /**
60
  * @param $id
61
  * @return int
62
  */
63
  public function destroy($id)
64
  {
65
    return $this->repository->delete($id);
66
  }
67
}

1
<?php
2
Route::group(['middleware' => 'auth:api'], function () {
3
  Route::get('/me', 'AuthController@me');
4
  Route::post('/logout', 'AuthController@logout');
5

6
  // Task
7
  Route::resource('tasks', 'TasksController',
8
    ['only' => ['index', 'show', 'store', 'update', 'destroy']]
9
  );
10
});

1
<?php
2
namespace Tests\Feature;
3

4
use Tests\TestCase;
5
use Illuminate\Foundation\Testing\RefreshDatabase;
6
use App\User;
7

8
class TaskTest extends TestCase
9
{
10
  use RefreshDatabase;
11

12
  public function setUp()
13
  {
14
    parent::setUp();
15
    $this->artisan('db:seed');
16

17
    // ログイン認証
18
    $user = factory(User::class)->create();
19
    $this->actingAs($user, 'api');
20
  }
21

22
  /**
23
  * @test
24
  */
25
  public function GETでアクセスするとjsonが返却()
26
  {
27
    $response = $this->get('api/tasks');
28
    $this->assertThat($response->content(), $this->isJson());
29
  }
30

31
  /**
32
  * @test
33
  */
34
  public function SHOWで取得情報は正しいか()
35
  {
36
    $response = $this->get('api/tasks/1');
37
    $response->assertJson([
38
      'title' => 'はじめてのタスク'
39
    ])->assertStatus(200);
40
  }
41

42
  /**
43
  * @test
44
  */
45
  public function GETで取得できるjsonは要件通りである()
46
  {
47
    $response = $this->get('api/tasks');
48
    $tasks = $response->json();
49
    $task = $tasks[0];
50
    $this->assertSame(['id', 'title', 'state_id', 'user_id', 'due_at', 'created_at', 'updated_at'], array_keys($task));
51
  }
52

53
  /**
54
  * @test
55
  */
56
  public function GETの取得件数は2件である()
57
  {
58
    $response = $this->get('api/tasks');
59
    $response->assertJsonCount(2);
60
  }
61

62
  /**
63
  * @test
64
  */
65
  public function POSTでデータが追加される()
66
  {
67
    $params = [
68
      'title' => 'テストタイトル',
69
      'state_id' => '1',
70
      'user_id' => '1'
71
    ];
72
    $this->postJson('api/tasks', $params);
73
    $this->assertDatabaseHas('tasks', $params);
74
  }
75

76
  /**
77
  * @test
78
  */
79
  public function POSTでtitleが未入力のエラー()
80
  {
81
    $params = [
82
      'state_id' => '2',
83
      'user_id' => '2'
84
    ];
85
    $response = $this->postJson('api/tasks', $params);
86
    $response->assertJsonFragment(['title' => ['タイトルは必ず入力してください。']]);
87
  }
88

89
  /**
90
  * @test
91
  */
92
  public function UPDATEで情報は更新されるか()
93
  {
94
    $params = [
95
      'title' => '書き換えたタイトル'
96
    ];
97
    $respose = $this->putJson('api/tasks/1', $params);
98

99
    $this->assertTrue($respose->json());
100
    $this->assertDatabaseHas('tasks', $params);
101
  }
102

103
  /**
104
  * @test
105
  */
106
  public function DALETEで情報は削除されるか()
107
  {
108
    $params = [
109
      'id' => 1
110
    ];
111
    $this->deleteJson('api/tasks/1');
112
    $this->assertDatabaseMissing('tasks', $params);
113
  }
114
}