feat: implement GenericResponse class and update controllers to use it for consistent JSON responses

src/Controllers/HealthcheckController.php

@@ -8,6 +8,7 @@ use Illuminate\Database\PostgresConnection;
 use Nyholm\Psr7\ServerRequest;
 use Psr\Http\Message\ResponseInterface;
 use Siteworxpro\App\Http\JsonResponseFactory;
+use Siteworxpro\App\Http\Responses\GenericResponse;
 use Siteworxpro\App\Models\Model;
 use Siteworxpro\App\Services\Facades\Redis;
 use Siteworxpro\HttpStatus\CodesEnum;
@@ -53,7 +54,7 @@ class HealthcheckController extends Controller
         }
 
         return JsonResponseFactory::createJsonResponse(
-            ['status_code' => 200, 'message' => 'Healthcheck OK']
+            new GenericResponse('Healthcheck OK', CodesEnum::OK->value)
         );
     }
 }

src/Controllers/IndexController.php

@@ -11,6 +11,7 @@ use Siteworxpro\App\Docs\TokenSecurity;
 use Siteworxpro\App\Docs\UnauthorizedResponse;
 use Siteworxpro\App\Http\JsonResponseFactory;
 use OpenApi\Attributes as OA;
+use Siteworxpro\App\Http\Responses\GenericResponse;
 
 /**
  * Class IndexController
@@ -31,15 +32,12 @@ class IndexController extends Controller
     #[OA\Response(
         response: '200',
         description: 'An Example Response',
-        content: new OA\JsonContent(properties: [
+        content: new OA\JsonContent(ref: '#/components/schemas/GenericResponse')
-            new OA\Property('status_code', type: 'integer'),
-            new OA\Property('message', type: 'string'),
-        ])
     )]
     #[UnauthorizedResponse]
     public function get(ServerRequest $request): ResponseInterface
     {
-        return JsonResponseFactory::createJsonResponse(['status_code' => 200, 'message' => 'Server is running']);
+        return JsonResponseFactory::createJsonResponse(['message' => 'Server is running']);
     }
 
     /**
@@ -53,16 +51,11 @@ class IndexController extends Controller
     #[OA\Response(
         response: '200',
         description: 'An Example Response',
-        content: new OA\JsonContent(
+        content: new OA\JsonContent(ref: '#/components/schemas/GenericResponse')
-            properties: [
-                new OA\Property('status_code', type: 'integer'),
-                new OA\Property('message', type: 'string'),
-            ]
-        )
     )]
     #[UnauthorizedResponse]
     public function post(ServerRequest $request): ResponseInterface
     {
-        return JsonResponseFactory::createJsonResponse(['status_code' => 200, 'message' => 'Server is running']);
+        return JsonResponseFactory::createJsonResponse(new GenericResponse('POST request received'));
     }
 }

src/Controllers/OpenApiController.php

@@ -22,6 +22,7 @@ class OpenApiController extends Controller
         $openapi = new Generator()->generate([
             __DIR__ . '/../Controllers',
             __DIR__ . '/../Models',
+            __DIR__ . '/../Http/Responses',
         ]);
 
         $response = new Response();

src/Http/JsonResponseFactory.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Siteworxpro\App\Http;
 
+use Illuminate\Contracts\Support\Arrayable;
 use Nyholm\Psr7\Response;
 use Siteworxpro\HttpStatus\CodesEnum;
 
@@ -17,13 +18,19 @@ class JsonResponseFactory
     /**
      * Create a JSON response with the given data and status code.
      *
-     * @param array $data The data to include in the response.
+     * @param array|Arrayable $data The data to include in the response.
      * @param CodesEnum $statusCode The HTTP status code for the response.
      * @return Response The JSON response.
      * @throws \JsonException
      */
-    public static function createJsonResponse(array $data, CodesEnum $statusCode = CodesEnum::OK): Response
+    public static function createJsonResponse(
-    {
+        array|Arrayable $data,
+        CodesEnum $statusCode = CodesEnum::OK
+    ): Response {
+        if ($data instanceof Arrayable) {
+            $data = $data->toArray();
+        }
+
         return new Response(
             status: $statusCode->value,
             headers: [

src/Http/Responses/GenericResponse.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Siteworxpro\App\Http\Responses;
+
+use Illuminate\Contracts\Support\Arrayable;
+use OpenApi\Attributes as OA;
+
+#[OA\Schema(
+    schema: 'GenericResponse',
+    properties: [
+        new OA\Property(property: 'message', type: 'string', example: 'Operation completed successfully.'),
+        new OA\Property(property: 'status_code', type: 'integer', example: 200),
+    ]
+)]
+readonly class GenericResponse implements Arrayable
+{
+    public function __construct(
+        private string $message = '',
+        private int $statusCode = 200
+    ) {
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'message' => $this->message,
+            'status_code' => $this->statusCode,
+        ];
+    }
+}