今回は小説を投稿するためのAPIを作成してみました。APIの要件は以下のようになっています。

■要件

• ・小説のタイトルと本文とジャンルを新規作成するCreate
• ・登録されている小説を一覧表示するRead
• ・選択した小説の内容を表示するShow
• ・投稿した小説を編集する Update
• ・投稿した内容を削除するDelete

テーブルは以下のような構成になっています。

■テーブル構成

• ・タイトル
• ・本文
• ・カテゴリ
• ・作成日
• ・更新日

小説なのでnovelsという名前のテーブルにしました。

Laravel8からはオプションに-mcrを付けることで一度にモデルとコントローラーとマイグレーションファイルを作成できます。

1. $ php artisan make:model Novel -mcr

migrationファイル

1.  public function up()
2.     {
3.         Schema::create('novels', function (Blueprint $table) {
4.             $table->id();
5.             $table->string('title');
6.             $table->string('content');
7. 　　　　　　　　　　　　　　　　　　　　　　　　$table->string('category');
8.             $table->timestamps();
9.         });
10.     }

migration実行

1. $ php artisan migrate

ポイント　$fillableの配列にカラムを指定することでモデルクラスから登録や更新が出来るようになります。追加するのは登録するのを許可するという意味になります。

1. class Novel extends Model
2. {
3.     use HasFactory;
5.     // fillableに指定したプロパティは入力可能になる
6.     protected $fillable = [
7.     'title',
8.     'content',
9.     'category'
10.     ];
11. }

ちなみに登録させたくない場合はguardedに追加します。

1. 例：
2. protected $guarded = ['created_at', 'updated_at'];
3. }

APIなのでroutes/api.phpに記載します。

1. Route::middleware(['middleware' => 'api'])->group(function () {
2.     Route::controller(NovelController::class)->group(function () {
3.         Route::post('/novels/create', 'create');
4.         Route::get('novels', 'index');
5.         Route::get('/novels/{novel}', 'show');
6.         Route::patch('/novels/update/{novel}', 'update');
7.         Route::delete('/novels/{novel}', 'destroy');
8.     });
9. });

■ ポイント

createやshowメソッドで引数にモデルクラスを指定しています。これはルーティングにIDを含めることで暗黙の結合をしています。このように書くことでfindでIDからデータを取得する手間を省くことが出来ます。

1. <?php
3. namespace App\Http\Controllers\Api;
5. use App\Models\Novel;
6. use Illuminate\Http\Request;
7. use App\Http\Controllers\Controller;
9. class NovelController extends Controller
10. {
11.     /**
12.      *
13.      * @return \Illuminate\Http\Response
14.      */
15.     public function index()
16.     {
17.         $novels = Novel::all();
18.         return response()->json($novels);
19.     }
21.     /**
22.      * Show the form for creating a new resource.
23.      *
24.      * @return \Illuminate\Http\Response
25.      */
26.     public function create(Request $request, Novel $novel)
27.     {
28.       $novel->create($request->all());
29.         return response()->json(Novel::all());
30.     }
32.     /**
33.      * Store a newly created resource in storage.
34.      *
35.      * @param \Illuminate\Http\Request $request
36.      * @return \Illuminate\Http\Response
37.      */
38.     public function store(Request $request)
39.     {
40.         //
41.     }
43.     /**
44.      * Display the specified resource.
45.      *
46.      * @param \App\Models\Novel $novel
47.      * @return \Illuminate\Http\Response
48.      */
49.     public function show(Novel $novel)
50.     {
51.         return response()->json($novel);
52.     }
54.     /**
55.      * Show the form for editing the specified resource.
56.      *
57.      * @param \App\Models\Novel $novel
58.      * @return \Illuminate\Http\Response
59.      */
60.     public function edit(Novel $novel)
61.     {
62.         //
63.     }
65.     /**
66.      * Update the specified resource in storage.
67.      *
68.      * @param \Illuminate\Http\Request $request
69.      * @param \App\Models\Novel $novel
70.      * @return \Illuminate\Http\Response
71.      */
72.     public function update(Request $request, Novel $novel)
73.     {
74.         $novel->update($request->all());
75.         return response()->json($novel);
76.     }
78.     /**
79.      * Remove the specified resource from storage.
80.      *
81.      * @param \App\Models\Novel $novel
82.      * @return \Illuminate\Http\Response
83.      */
84.     public function destroy(Novel $novel)
85.     {
86.         $novel->delete();
87.         return response()->json(Novel::all());
88.     }
89. }

一通り実装出来たのでpostmanを使って動作確認をしていきます。postmanはAPIをテストするのに便利なツールです。

1 一覧表示の同作確認

routes/api.php

1. Route::middleware(['middleware' => 'api'])->group(function () {
2.     Route::controller(NovelController::class)->group(function () {
3.         Route::post('/novels/create', 'create');
4.         Route::get('novels', 'index');
5.         Route::get('/novels/{novel}', 'show');
6.         Route::patch('/novels/update/{novel}', 'update');
7.         Route::delete('/novels/{novel}', 'destroy');
8.     });
9. });

app/Http/Api/NovelController.php

1. /**
2.      *
3.      * @return \Illuminate\Http\Response
4.      */
5.     public function index()
6.     {
7.         $novels = Novel::all();
8.         return response()->json($novels);
9.     }

postmanでURLを叩いて実行。登録済のデータが返ってきたことを確認出来ました。

2 新規登録の同作確認

1. /**
2.      * Show the form for creating a new resource.
3.      *
4.      * @return \Illuminate\Http\Response
5.      */
6.     public function create(Request $request, Novel $novel)
7.     {
8.       $novel->create($request->all());
9.         return response()->json(Novel::all());
10.     }

新規登録も問題なく動作確認が出来ました。

3 showメソッドの同作確認

1. /**
2.      * Display the specified resource.
3.      *
4.      * @param \App\Models\Novel $novel
5.      * @return \Illuminate\Http\Response
6.      */
7.     public function show(Novel $novel)
8.     {
9.         return response()->json($novel);
10.     }

先ほど新規登録したid5を指定すると結果が問題なく返ってきています。

4 updateメソッドの同作確認

1.  /**
2.      * Update the specified resource in storage.
3.      *
4.      * @param \Illuminate\Http\Request $request
5.      * @param \App\Models\Novel $novel
6.      * @return \Illuminate\Http\Response
7.      */
8.     public function update(Request $request, Novel $novel)
9.     {
10.         $novel->update($request->all());
11.         return response()->json($novel);
12.     }

先ほど新規登録したid5を更新処理テストにして実行した所、問題なく更新が実行されました。

5 destroyメソッドの同作確認

1. /**
2.      * Remove the specified resource from storage.
3.      *
4.      * @param \App\Models\Novel $novel
5.      * @return \Illuminate\Http\Response
6.      */
7.     public function destroy(Novel $novel)
8.     {
9.         $novel->delete();
10.         return response()->json(Novel::all());
11.     }

id5を削除するように指定したので、削除された結果が返ってきたことを確認出来ました。