rv readme

Author: idw-coder

README.md

@@ -458,4 +458,59 @@ graph TB
     style EmailError3 fill:#f8d7da
     style CreateUser fill:#fff3cd
     style UpdateGoogleId fill:#fff3cd
-```
+```
+
+### APIのエラーハンドリングとレスポンス形式
+
+ルート一覧を確認
+```bash
+wida@LAPTOP-2C4PL9J8:~/dev/laravel-rds$ ./vendor/bin/sail artisan route:list
+WARN[0001] The "MYSQL_EXTRA_OPTIONS" variable is not set. Defaulting to a blank string.
+WARN[0000] The "MYSQL_EXTRA_OPTIONS" variable is not set. Defaulting to a blank string.
+
+  GET|HEAD        / ..........................................................................................................................
+  GET|HEAD        api/auth/google .................................................................. Api\GoogleAuthController@redirectToGoogle
+  GET|HEAD        api/auth/google/callback ..................................................... Api\GoogleAuthController@handleGoogleCallback
+  POST            api/login ................................................................................. login › Api\AuthController@login
+  POST            api/logout ....................................................................................... Api\AuthController@logout
+  GET|HEAD        api/posts ........................................................................... posts.index › Api\PostController@index
+  POST            api/posts ........................................................................... posts.store › Api\PostController@store
+  GET|HEAD        api/posts/{post} ...................................................................... posts.show › Api\PostController@show
+  PUT|PATCH       api/posts/{post} .................................................................. posts.update › Api\PostController@update
+  DELETE          api/posts/{post} ................................................................ posts.destroy › Api\PostController@destroy
+  GET|HEAD        api/profile ........................................................................................ Api\UserController@show
+  PUT             api/profile ...................................................................................... Api\UserController@update
+  GET|HEAD        api/test ...................................................................................................................
+  GET|HEAD        api/user ...................................................................................................................
+  GET|HEAD        sanctum/csrf-cookie ...................................... sanctum.csrf-cookie › Laravel\Sanctum › CsrfCookieController@show
+  GET|HEAD        storage/{path} ............................................................................................... storage.local
+  GET|HEAD        up .........................................................................................................................
+
+                                                                                                                           Showing [17] routes
+```
+
+上記について表にまとめると
+
+<div style="font-size: 85%;">
+
+| メソッド | URI | ルート名（識別子） | コントローラーのメソッド名 | コントローラー（クラス） |
+|---------|-----|-------------------|-------------------------|----------------------|
+| GET\|HEAD | / | - | - | - |
+| GET\|HEAD | api/auth/google | - | redirectToGoogle | Api\GoogleAuthController |
+| GET\|HEAD | api/auth/google/callback | - | handleGoogleCallback | Api\GoogleAuthController |
+| POST | api/login | login | login | Api\AuthController |
+| POST | api/logout | - | logout | Api\AuthController |
+| GET\|HEAD | api/posts | posts.index | index | Api\PostController |
+| POST | api/posts | posts.store | store | Api\PostController |
+| GET\|HEAD | api/posts/{post} | posts.show | show | Api\PostController |
+| PUT\|PATCH | api/posts/{post} | posts.update | update | Api\PostController |
+| DELETE | api/posts/{post} | posts.destroy | destroy | Api\PostController |
+| GET\|HEAD | api/profile | - | show | Api\UserController |
+| PUT | api/profile | - | update | Api\UserController |
+| GET\|HEAD | api/test | - | - | - |
+| GET\|HEAD | api/user | - | - | - |
+| GET\|HEAD | sanctum/csrf-cookie | sanctum.csrf-cookie | show | Laravel\Sanctum\CsrfCookieController |
+| GET\|HEAD | storage/{path} | storage.local | - | - |
+| GET\|HEAD | up | - | - | - |
+
+</div>

routes/api.php

@@ -12,7 +12,34 @@
     return response()->json(['message' => 'API is working']);
 });
 
-// ログインは認証不要
+/**
+ * ログイン（認証不要）
+ * 
+ * ルート名: login
+ * URI: POST /api/login
+ * HTTPメソッド: POST
+ * 
+ * [AuthController::class, 'login']
+ *  - コントローラークラス: App\Http\Controllers\Api\AuthController
+ *  - コントローラーメソッド: login()
+ * 
+ * 引数:
+ *   - Request $request: リクエストオブジェクト
+ *     - email (string, required): ユーザーのメールアドレス
+ *     - password (string, required): ユーザーのパスワード
+ * 
+ * 処理内容:
+ *   1. メールアドレスとパスワードでバリデーション
+ *   2. Googleログイン用アカウントの場合はエラーを返す
+ *   3. メール・パスワードで認証を試行
+ *   4. 認証成功時、Sanctumトークンを発行
+ * 
+ * 返り値:
+ *   - 成功時 (200): {'token': string, 'user': User}
+ *   - バリデーションエラー (422): {'message': string, 'errors': array}
+ *   - 認証失敗 (401): {'message': string}
+ *   - サーバーエラー (500): {'message': string}
+ */
 Route::post('/login', [AuthController::class, 'login'])->name('login');
 
 // Google OAuth（認証不要）