feat: add Swagger integration with OpenAPI annotations and endpoints

src/Controllers/IndexController.php

@@ -8,6 +8,7 @@ use Nyholm\Psr7\ServerRequest;
 use Psr\Http\Message\ResponseInterface;
 use Siteworxpro\App\Attributes\Guards;
 use Siteworxpro\App\Http\JsonResponseFactory;
+use OpenApi\Attributes as OA;
 
 /**
  * Class IndexController
@@ -24,6 +25,15 @@ class IndexController extends Controller
     #[Guards\Jwt]
     #[Guards\Scope(['get.index', 'status.check'])]
     #[Guards\RequireAllScopes]
+    #[OA\Get(path: '/')]
+    #[OA\Response(
+        response: '200',
+        description: 'An Example Response',
+        content: new OA\JsonContent(properties: [
+            new OA\Property('status_code', type: 'integer'),
+            new OA\Property('message', type: 'string'),
+        ])
+    )]
     public function get(ServerRequest $request): ResponseInterface
     {
         return JsonResponseFactory::createJsonResponse(['status_code' => 200, 'message' => 'Server is running']);
@@ -34,6 +44,17 @@ class IndexController extends Controller
      */
     #[Guards\Jwt]
     #[Guards\Scope(['post.index'])]
+    #[OA\Post(path: '/')]
+    #[OA\Response(
+        response: '200',
+        description: 'An Example Response',
+        content: new OA\JsonContent(
+            properties: [
+                new OA\Property('status_code', type: 'integer'),
+                new OA\Property('message', type: 'string'),
+            ]
+        )
+    )]
     public function post(ServerRequest $request): ResponseInterface
     {
         return JsonResponseFactory::createJsonResponse(['status_code' => 200, 'message' => 'Server is running']);