Refactor AuthController to enhance documentation and update file permissions

Author: idw-coder

app/Http/Controllers/Api/AuthController.php

@@ -12,7 +12,21 @@
 
 class AuthController extends Controller
 {
-    public function login(Request $request) // Request は引数 $request の型（型ヒント）$request が Request クラスのインスタンス
+    /**
+     * ログイン処理
+     * 
+     * @param Request $request リクエストオブジェクト
+     *   - email (string, required): ユーザーのメールアドレス
+     *   - password (string, required): ユーザーのパスワード
+     * 
+     * @return \Illuminate\Http\JsonResponse
+     *   - 200: 成功時 {'authToken': string, 'user': User}
+     *   - 400: このアカウントは Google アカウントでログインしてください。
+     *   - 401: ログイン情報が正しくありません。
+     *   - 422: バリデーションエラー {'message': string, 'errors': array}
+     *   - 500: サーバーエラー {'message': string}
+     */
+    public function login(Request $request)
     {
         try {
             // 配列の各キーを値のルールでバリデーション
@@ -42,7 +56,8 @@ public function login(Request $request) // Request は引数 $request の型（
             /** @var User $user */
             $user = Auth::user();
 
-            /** Sanctum トークン発行
+            /**
+             * Sanctum トークン発行
              * createToken(name): トークン名を指定してトークンを発行
              * plainTextToken: トークンを文字列で返却
              */
@@ -90,6 +105,19 @@ public function login(Request $request) // Request は引数 $request の型（
         }
     }
 
+    /**
+     * ユーザー登録処理
+     * 
+     * @param Request $request リクエストオブジェクト
+     *   - name (string, required, max:255): ユーザー名
+     *   - email (string, required, email, unique): ユーザーのメールアドレス（重複不可）
+     *   - password (string, required, min:8): ユーザーのパスワード（最小8文字）
+     * 
+     * @return \Illuminate\Http\JsonResponse
+     *   - 201: 成功時 {'authToken': string, 'user': User}
+     *   - 422: バリデーションエラー {'message': string, 'errors': array}
+     *   - 500: サーバーエラー {'message': string}
+     */
     public function register(Request $request)
     {
         try {
@@ -160,6 +188,14 @@ public function register(Request $request)
         }
     }
 
+    /**
+     * ログアウト処理
+     * 
+     * @param Request $request リクエストオブジェクト（認証済みユーザーのトークンを含む）
+     * 
+     * @return \Illuminate\Http\JsonResponse
+     *   - 200: 成功時 {'message': string}
+     */
     public function logout(Request $request)
     {
         $request->user()->currentAccessToken()->delete();

routes/api.php

@@ -12,58 +12,10 @@
     return response()->json(['message' => 'API is working']);
 });
 
-/**
- * ログイン
- * [AuthController::class, 'login']
- * @param Request $request
- * 
- * 引数:
- *   - 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');
 
-/**
- * ユーザー登録（認証不要）
- * 
- * ルート名: register
- * URI: POST /api/register
- * HTTPメソッド: POST
- * 
- * [AuthController::class, 'register']
- *  - コントローラークラス: App\Http\Controllers\Api\AuthController
- *  - コントローラーメソッド: register()
- * 
- * 引数:
- *   - Request $request: リクエストオブジェクト
- *     - name (string, required, max:255): ユーザー名
- *     - email (string, required, email, unique): ユーザーのメールアドレス（重複不可）
- *     - password (string, required, min:8): ユーザーのパスワード（最小8文字）
- * 
- * 処理内容:
- *   1. 名前、メールアドレス、パスワードでバリデーション
- *   2. ユーザーを作成（パスワードはハッシュ化）
- *   3. 'free' ロールを自動付与
- *   4. Sanctumトークンを発行してログイン状態にする
- * 
- * 返り値:
- *   - 成功時 (201): {'token': string, 'user': User}
- *   - バリデーションエラー (422): {'message': string, 'errors': array}
- *   - サーバーエラー (500): {'message': string}
- */
+// ユーザー登録
 Route::post('/register', [AuthController::class, 'register'])->name('register');
 
 // Google OAuth（認証不要）