Merge pull request #306 from dotkernel/issue-168

Issue #168: OpenAPI documentation

Author: arhimede

composer.json

@@ -78,7 +78,8 @@
         "mezzio/mezzio-twigrenderer": "^2.15.0",
         "ramsey/uuid-doctrine": "^2.1.0",
         "roave/psr-container-doctrine": "^5.2.1",
-        "symfony/filesystem": "^7.0.3"
+        "symfony/filesystem": "^7.0.3",
+        "zircote/swagger-php": "^4.10"
     },
     "require-dev": {
         "laminas/laminas-coding-standard": "^2.5",

src/Admin/src/Entity/Admin.php

@@ -54,6 +54,7 @@ public function __construct()
     {
         parent::__construct();
 
+        $this->created();
         $this->roles = new ArrayCollection();
     }
 

src/Admin/src/Entity/AdminRole.php

@@ -24,6 +24,13 @@ class AdminRole extends AbstractEntity implements RoleInterface
         self::ROLE_SUPERUSER,
     ];
 
+    public function __construct()
+    {
+        parent::__construct();
+
+        $this->created();
+    }
+
     #[ORM\Column(name: "name", type: "string", length: 30, unique: true)]
     protected string $name = '';
 

src/Admin/src/Handler/AdminHandler.php

@@ -58,6 +58,9 @@ public function get(ServerRequestInterface $request): ResponseInterface
         return $this->createResponse($request, $admin);
     }
 
+    /**
+     * @throws BadRequestException
+     */
     public function getCollection(ServerRequestInterface $request): ResponseInterface
     {
         return $this->createResponse($request, $this->adminService->getAdmins($request->getQueryParams()));

src/Admin/src/Handler/AdminRoleHandler.php

@@ -5,6 +5,7 @@
 namespace Api\Admin\Handler;
 
 use Api\Admin\Service\AdminRoleServiceInterface;
+use Api\App\Exception\BadRequestException;
 use Api\App\Exception\NotFoundException;
 use Api\App\Handler\HandlerTrait;
 use Dot\DependencyInjection\Attribute\Inject;
@@ -42,11 +43,11 @@ public function get(ServerRequestInterface $request): ResponseInterface
         return $this->createResponse($request, $role);
     }
 
+    /**
+     * @throws BadRequestException
+     */
     public function getCollection(ServerRequestInterface $request): ResponseInterface
     {
-        return $this->createResponse(
-            $request,
-            $this->roleService->getAdminRoles($request->getQueryParams())
-        );
+        return $this->createResponse($request, $this->roleService->getAdminRoles($request->getQueryParams()));
     }
 }