feat(routing): added missing route attributes (#3877)

Author: thorsten

phpmyfaq/api/index.php

@@ -61,12 +61,12 @@
     echo $e->getMessage();
 }
 
-$routes = include PMF_SRC_DIR . '/api-routes.php';
-
 $app = new Application($container);
 $app->setApiContext(true);
+$app->setRoutingContext('api');
 try {
-    $app->run($routes);
+    // Autoload routes from attributes (falls back to api-routes.php during migration)
+    $app->run();
 } catch (Exception $exception) {
     echo $exception->getMessage();
 }

phpmyfaq/setup/index.php

@@ -25,7 +25,7 @@
 
 use Composer\Autoload\ClassLoader;
 use phpMyFAQ\Application;
-use phpMyFAQ\Controller\Frontend\Api\SetupController;
+use phpMyFAQ\Controller\Frontend\SetupController;
 use phpMyFAQ\Environment;
 use phpMyFAQ\Strings;
 use phpMyFAQ\Translation;

phpmyfaq/src/admin-routes.php

@@ -35,9 +35,9 @@
 use phpMyFAQ\Controller\Administration\InstanceController;
 use phpMyFAQ\Controller\Administration\NewsController;
 use phpMyFAQ\Controller\Administration\OpenQuestionsController;
-use phpMyFAQ\Controller\Administration\PageController;
 use phpMyFAQ\Controller\Administration\OpenSearchController;
 use phpMyFAQ\Controller\Administration\OrphanedFaqsController;
+use phpMyFAQ\Controller\Administration\PageController;
 use phpMyFAQ\Controller\Administration\PasswordChangeController;
 use phpMyFAQ\Controller\Administration\PluginController;
 use phpMyFAQ\Controller\Administration\RatingController;

phpmyfaq/src/api-routes.php

@@ -89,7 +89,7 @@
         'controller' => [FaqController::class, 'update'],
         'methods' => 'PUT',
     ],
-    'api.faq-by-id' => [
+    'api.faq.by-id' => [
         'path' => "v{$apiVersion}/faq/{categoryId}/{faqId}",
         'controller' => [FaqController::class, 'getById'],
         'methods' => 'GET',

phpmyfaq/src/phpMyFAQ/Controller/Api/BackupController.php

@@ -32,6 +32,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
+use Symfony\Component\Routing\Attribute\Route;
 
 final class BackupController extends AbstractController
 {
@@ -82,6 +83,7 @@ public function __construct()
         response: 401,
         description: 'If the user is not authenticated and/or does not have sufficient permissions.',
     )]
+    #[Route(path: 'v3.2/backup/{type}', name: 'api.backup', methods: ['GET'])]
     public function download(Request $request): Response
     {
         $this->userHasPermission(PermissionType::BACKUP);

phpmyfaq/src/phpMyFAQ/Controller/Api/CategoryController.php

@@ -19,18 +19,19 @@
 
 namespace phpMyFAQ\Controller\Api;
 
+use JsonException;
 use OpenApi\Attributes as OA;
 use phpMyFAQ\Category;
 use phpMyFAQ\Category\Order;
 use phpMyFAQ\Category\Permission as CategoryPermission;
-use phpMyFAQ\Core\Exception;
 use phpMyFAQ\Entity\CategoryEntity;
 use phpMyFAQ\Filter;
 use phpMyFAQ\Language;
 use phpMyFAQ\User\CurrentUser;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
 
 final class CategoryController extends AbstractApiController
 {
@@ -124,6 +125,7 @@ enum: ['id', 'name', 'parent_id', 'active'],
             }
         }'),
     )]
+    #[Route(path: 'v3.2/categories', name: 'api.categories.list', methods: ['GET'])]
     public function list(): JsonResponse
     {
         /** @var Language $language */
@@ -168,7 +170,8 @@ public function list(): JsonResponse
     }
 
     /**
-     * @throws Exception|\JsonException
+     * @throws JsonException
+     * @throws \Exception
      */
     #[OA\Post(path: '/api/v3.2/category', operationId: 'createCategory', tags: ['Endpoints with Authentication'])]
     #[OA\Header(
@@ -244,6 +247,7 @@ public function list(): JsonResponse
         ),
     )]
     #[OA\Response(response: 401, description: 'If the user is not authenticated.')]
+    #[Route(path: 'v3.2/category', name: 'api.category.create', methods: ['POST'])]
     public function create(Request $request): JsonResponse
     {
         $this->hasValidToken();

phpmyfaq/src/phpMyFAQ/Controller/Api/CommentController.php

@@ -26,7 +26,7 @@
 use phpMyFAQ\Filter;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
 
 final class CommentController extends AbstractApiController
 {
@@ -128,6 +128,7 @@ enum: ['id_comment', 'id', 'usr', 'email', 'datum'],
             }
         }',
     ))]
+    #[Route(path: 'v3.2/comments/{recordId}', name: 'api.comments', methods: ['GET'])]
     public function list(Request $request): JsonResponse
     {
         $recordId = (int) Filter::filterVar($request->attributes->get(key: 'recordId'), FILTER_VALIDATE_INT);

phpmyfaq/src/phpMyFAQ/Controller/Api/FaqController.php

@@ -30,6 +30,7 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
 
 final class FaqController extends AbstractApiController
 {
@@ -71,6 +72,7 @@ final class FaqController extends AbstractApiController
         ]',
     ))]
     #[OA\Response(response: 404, description: 'If the category has no FAQs.', content: new OA\JsonContent(example: []))]
+    #[Route(path: 'v3.2/faqs/{categoryId}', name: 'api.faqs.by-category-id', methods: ['GET'])]
     public function getByCategoryId(Request $request): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -143,6 +145,7 @@ public function getByCategoryId(Request $request): JsonResponse
         description: 'If there are no FAQs for the given FAQ ID.',
         content: new OA\JsonContent(example: []),
     )]
+    #[Route(path: 'v3.2/faq/{categoryId}/{faqId}', name: 'api.faq.by-id', methods: ['GET'])]
     public function getById(Request $request): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -208,6 +211,7 @@ public function getById(Request $request): JsonResponse
         ]',
     ))]
     #[OA\Response(response: 404, description: 'If the tag ID has no FAQs.', content: new OA\JsonContent(example: []))]
+    #[Route(path: 'v3.2/faqs/tags/{tagId}', name: 'api.faqs.by-tag-id', methods: ['GET'])]
     public function getByTagId(Request $request): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -259,6 +263,7 @@ public function getByTagId(Request $request): JsonResponse
         description: "If there's not a single popular FAQ.",
         content: new OA\JsonContent(example: []),
     )]
+    #[Route(path: 'v3.2/faqs/popular', name: 'api.faqs.popular', methods: ['GET'])]
     public function getPopular(): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -307,6 +312,7 @@ public function getPopular(): JsonResponse
         description: "If there's not one latest FAQ.",
         content: new OA\JsonContent(example: []),
     )]
+    #[Route(path: 'v3.2/faqs/latest', name: 'api.faqs.latest', methods: ['GET'])]
     public function getLatest(): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -354,6 +360,7 @@ public function getLatest(): JsonResponse
         description: "If there's not a single trending FAQ.",
         content: new OA\JsonContent(example: []),
     )]
+    #[Route(path: 'v3.2/faqs/trending', name: 'api.faqs.trending', methods: ['GET'])]
     public function getTrending(): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -406,6 +413,7 @@ public function getTrending(): JsonResponse
         description: "If there's not one sticky FAQ.",
         content: new OA\JsonContent(example: []),
     )]
+    #[Route(path: 'v3.2/faqs/sticky', name: 'api.faqs.sticky', methods: ['GET'])]
     public function getSticky(): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -522,6 +530,7 @@ enum: ['id', 'title', 'author', 'updated', 'created'],
             }
         }',
     ))]
+    #[Route(path: 'v3.2/faqs', name: 'api.faqs.list', methods: ['GET'])]
     public function list(): JsonResponse
     {
         [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
@@ -658,6 +667,7 @@ public function list(): JsonResponse
         content: new OA\JsonContent(example: '{ "stored": false, "error": "The given category name was not found" }'),
     )]
     #[OA\Response(response: 401, description: 'If the user is not authenticated.')]
+    #[Route(path: 'v3.2/faq/create', name: 'api.faq.create', methods: ['POST'])]
     public function create(Request $request): JsonResponse
     {
         $this->hasValidToken();
@@ -693,7 +703,7 @@ public function create(Request $request): JsonResponse
         $isActive = Filter::filterVar($data->{'is-active'}, FILTER_VALIDATE_BOOLEAN);
         $isSticky = Filter::filterVar($data->{'is-sticky'}, FILTER_VALIDATE_BOOLEAN);
 
-        // Check if category name can be mapped
+        // Check if the category name can be mapped
         if (!is_null($categoryName)) {
             $categoryIdFound = $category->getCategoryIdFromName($categoryName);
             if ($categoryIdFound === false) {
@@ -816,6 +826,7 @@ public function create(Request $request): JsonResponse
         ),
     )]
     #[OA\Response(response: 401, description: 'If the user is not authenticated.')]
+    #[Route(path: 'v3.2/faq/update', name: 'api.faq.update', methods: ['PUT'])]
     public function update(Request $request): JsonResponse
     {
         $this->hasValidToken();

phpmyfaq/src/phpMyFAQ/Controller/Api/GlossaryController.php

@@ -24,6 +24,7 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
 
 final class GlossaryController extends AbstractApiController
 {
@@ -111,6 +112,7 @@ final class GlossaryController extends AbstractApiController
             }
         }',
     ))]
+    #[Route(path: 'v3.2/glossary', name: 'api.glossary.list', methods: ['GET'])]
     public function list(Request $request): JsonResponse
     {
         $glossary = $this->container->get(id: 'phpmyfaq.glossary');

phpmyfaq/src/phpMyFAQ/Controller/Api/GroupController.php

@@ -108,6 +108,7 @@ final class GroupController extends AbstractApiController
         }',
     ))]
     #[OA\Response(response: 401, description: 'If the user is not authenticated.')]
+    #[Route(path: 'v3.2/groups', name: 'api.groups', methods: ['GET'])]
     public function list(): JsonResponse
     {
         $this->userIsAuthenticated();