feat: add Swagger UI service to docker-compose and update OpenAPI annotations in controllers

src/Api.php

@@ -11,7 +11,7 @@ use League\Route\Router;
 use Nyholm\Psr7\Factory\Psr17Factory;
 use Siteworxpro\App\Controllers\HealthcheckController;
 use Siteworxpro\App\Controllers\IndexController;
-use Siteworxpro\App\Controllers\SwaggerController;
+use Siteworxpro\App\Controllers\OpenApiController;
 use Siteworxpro\App\Http\JsonResponseFactory;
 use Siteworxpro\App\Http\Middleware\CorsMiddleware;
 use Siteworxpro\App\Http\Middleware\JwtMiddleware;
@@ -74,8 +74,8 @@ class Api
         $this->router->get('/healthz', HealthcheckController::class . '::get');
 
         $this->router->group('/.well-known', function (RouteGroup $router) {
-            $router->get('/swagger.yaml', SwaggerController::class . '::get');
+            $router->get('/swagger.yaml', OpenApiController::class . '::get');
-            $router->get('/swagger.json', SwaggerController::class . '::get');
+            $router->get('/swagger.json', OpenApiController::class . '::get');
         });
 
         $this->router->middleware(new CorsMiddleware());

src/Controllers/OpenApiController.php

@@ -9,8 +9,14 @@ use Nyholm\Psr7\ServerRequest;
 use OpenApi\Generator;
 use Psr\Http\Message\ResponseInterface;
 
-class SwaggerController extends Controller
+class OpenApiController extends Controller
 {
+    /**
+     * Handles the GET request to generate and return the OpenAPI specification.
+     *
+     * @param ServerRequest $request
+     * @return ResponseInterface
+     */
     public function get(ServerRequest $request): ResponseInterface
     {
         $openapi = new Generator()->generate([