Add ApiModel attribute to controllers and implement dynamic model

README.md

@@ -32,13 +32,16 @@ $ npm install && npm run build
 # 3. Copy .env and configure
 $ cp .env.example .env
 
-# 4. Generate app key
+# 4. Configure Git hooks (Husky)
+$ git config core.hooksPath .husky
+
+# 5. Generate app key
 $ php artisan key:generate
 
-# 5. Run migrations and seeders
+# 6. Run migrations and seeders
 $ php artisan migrate --seed
 
-# 6. Start the server
+# 7. Start the server
 $ php artisan serve
 ```
 

app/Enums/UserOtpFor.php

@@ -5,13 +5,13 @@
 enum UserOtpFor: string
 {
     case FORGOT_PASSWORD = 'forgot_password';
-    case VERIFY_EMAIL = 'verify_email';
+    case EMAIL_VERIFICATION = 'email_verification';
 
     public function label(): string
     {
         return match ($this) {
             self::FORGOT_PASSWORD => 'Forgot Password',
-            self::VERIFY_EMAIL => 'Verify Email',
+            self::EMAIL_VERIFICATION => 'Email Verification',
         };
     }
 }

app/Http/Controllers/Api/AuthController.php

@@ -69,16 +69,16 @@ public function login(LoginRequest $request)
     }
 
     #[OA\Post(
-        path: '/api/forget-password',
-        operationId: 'forgetPassword',
+        path: '/api/forgot-password',
+        operationId: 'forgotPassword',
         tags: ['Auth'],
-        summary: 'Forget Password with otp',
+        summary: 'Forgot Password with otp',
         description: "Initiates the process to reset the user's password by otp.",
 
     )]
-    public function forgetPassword(ForgetPasswordRequest $request): JsonResponse
+    public function forgotPassword(ForgetPasswordRequest $request): JsonResponse
     {
-        $data = $this->authService->forgetPassword($request->validated());
+        $data = $this->authService->forgotPassword($request->validated());
 
         return $this->success($data, 200);
     }

app/Http/Controllers/Api/CountryController.php

@@ -9,6 +9,7 @@
 use App\Http\Controllers\Controller;
 use App\Http\Resources\Country\Collection as CountryCollection;
 use App\Models\Country;
+use App\OpenApi\Attributes\ApiModel;    
 
 
 class CountryController extends Controller
@@ -22,6 +23,7 @@ public function __construct()
         $this->countryService = new CountryService;
     }
 
+    #[ApiModel(Country::class)]
     #[OA\Get(
         path: '/api/countries',
         tags: ['Country'],

app/Http/Controllers/Api/LanguageController.php

@@ -8,6 +8,8 @@
 use App\Services\LanguageService;
 use Illuminate\Http\JsonResponse;
 use App\Http\Controllers\Controller;
+use App\Models\Language;
+use App\OpenApi\Attributes\ApiModel;
 
 class LanguageController extends Controller
 {
@@ -20,6 +22,7 @@ public function __construct()
         $this->langService = new LanguageService;
     }
 
+    #[ApiModel(Language::class)]
     #[OA\Get(
         path: '/api/languages',
         operationId: 'getLanguages',
@@ -33,6 +36,7 @@ public function index(Request $request): JsonResponse
         return $this->success($data, 200);
     }
 
+    #[ApiModel(Language::class)]
     #[OA\Get(
         path: '/api/languages/{language_id}',
         operationId: 'getLanguageId',

app/Http/Controllers/Api/MasterSettingController.php

@@ -10,6 +10,7 @@
 use App\Http\Resources\MasterSetting\Resource;
 use App\Models\MasterSetting;
 use App\Http\Resources\MasterSetting\Collection;
+use App\OpenApi\Attributes\ApiModel;
 
 class MasterSettingController extends Controller
 {
@@ -22,6 +23,7 @@ public function __construct()
         $this->masterSettingService = new MasterSettingService;
     }
 
+    #[ApiModel(MasterSetting::class)]
     #[OA\Get(
         path: '/api/settings',
         operationId: 'getMasterSettings',

app/Http/Controllers/Api/MediaController.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Http\Controllers\Api;
+
+use App\Traits\ApiResponser;
+use OpenApi\Attributes as OA;
+use App\Services\MediaService;
+use App\Http\Controllers\Controller;
+
+class MediaController extends Controller
+{
+    use ApiResponser;
+
+    public function __construct(private MediaService $mediaService) {}
+
+    #[OA\Delete(
+        path: '/api/v1/media/{mediaId}',
+        operationId: 'adminDeleteMedia',
+        tags: ['Media'],
+        summary: 'Mobile > Delete media file',
+        security: [['bearerAuth' => []]]
+    )]
+    public function destroy($id)
+    {
+        $data = $this->mediaService->destroy($id);
+
+        return $this->success($data);
+    }
+}

app/Http/Controllers/Api/NotificationController.php

@@ -9,6 +9,8 @@
 use App\Http\Requests\Notification\OneSignalData;
 use App\Http\Requests\Notification\Request as NotificationRequest;
 use App\Http\Resources\Notification\Collection as NotificationCollection;
+use App\Models\Notification;
+use App\OpenApi\Attributes\ApiModel;
 
 class NotificationController extends Controller
 {
@@ -21,6 +23,7 @@ public function __construct()
         $this->notificationService = new NotificationService;
     }
 
+    #[ApiModel(Notification::class)]
     #[OA\Get(
         path: '/api/notifications',
         operationId: 'notificationList',

app/Http/Controllers/Api/UserController.php

@@ -11,6 +11,8 @@
 use App\Http\Requests\User\UpdateProfile;
 use App\Http\Resources\User\Resource as UserResource;
 use App\Http\Requests\User\ChangePassword as UserChangePassword;
+use App\Models\User;
+use App\OpenApi\Attributes\ApiModel;
 
 class UserController extends Controller
 {
@@ -23,28 +25,11 @@ public function __construct()
         $this->userService = new UserService;
     }
 
+    #[ApiModel(User::class)]
     #[OA\Get(
         path: '/api/me',
         tags: ['Auth'],
         summary: 'Get logged-in user details',
-        // responses: [
-        //     new OA\Response(
-        //         response: 200,
-        //         description: 'Success'
-        //     ),
-        // ],
-        // parameters: [
-        //     new OA\Parameter(
-        //         name: 'X-Requested-With',
-        //         in: 'header',
-        //         required: true,
-        //         description: 'Custom header for XMLHttpRequest',
-        //         schema: new OA\Schema(
-        //             type: 'string',
-        //             default: 'XMLHttpRequest'
-        //         )
-        //     ),
-        // ],
         security: [[
             'bearerAuth' => [],
         ]]
@@ -88,7 +73,6 @@ public function stats(): JsonResponse
                 )
             ),
         ],
-
         security: [[
             'bearerAuth' => [],
         ]]

app/Mail/ForgetPasswordOtp.php

@@ -7,8 +7,9 @@
 use Illuminate\Mail\Mailables\Content;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Contracts\Queue\ShouldQueue;
 
-class ForgetPasswordOtp extends Mailable
+class ForgetPasswordOtp extends Mailable implements ShouldQueue
 {
     use Queueable, SerializesModels;
 

app/Models/Country.php

@@ -10,8 +10,17 @@ class Country extends Model
 {
     use BaseModel, HasFactory;
 
+    public $queryable = [
+        'id',
+    ];
+
+    public $defaultSort = 'name';
+
+    public $allowedSorts = ['id', 'name'];
+
     protected $fillable = [
         'name',
+        'iso',
         'iso3',
         'iso_code',
         'calling_code',
@@ -28,12 +37,4 @@ protected function casts(): array
             'deleted_at' => 'timestamp',
         ];
     }
-
-    public $queryable = [
-        'id',
-    ];
-
-    public $defaultSort = 'name';
-
-    public $allowedSorts = ['id', 'name'];
 }

app/OpenApi/Attributes/ApiDefaultModal.php → app/OpenApi/Attributes/ApiModel.php

@@ -6,9 +6,9 @@
 use Attribute;
 
 #[Attribute(Attribute::TARGET_METHOD)]
-class ApiDefaultModal
+class ApiModel
 {
-    public function __construct(public string $modelName)
+    public function __construct(public string $model)
     {
         // parent::__construct(response: 401, description: $description);
     }