Make the requirements configurable

Closes #1401

Author: Grégoire Paris

src/Bridge/Symfony/Routing/ApiLoader.php

@@ -114,7 +114,7 @@ public function load($data, $type = null): RouteCollection
                             'operationId' => $operationId,
                         ],
                     ],
-                    [],
+                    $operation['requirements'] ?? [],
                     [],
                     '',
                     [],
@@ -186,7 +186,7 @@ private function addRoute(RouteCollection $routeCollection, string $resourceClas
                 '_api_resource_class' => $resourceClass,
                 sprintf('_api_%s_operation_name', $operationType) => $operationName,
             ],
-            [],
+            $operation['requirements'] ?? [],
             [],
             '',
             [],

tests/Bridge/Symfony/Routing/ApiLoaderTest.php

@@ -47,21 +47,21 @@ public function testApiLoader()
         $resourceMetadata = $resourceMetadata->withShortName('dummy');
         //default operation based on OperationResourceMetadataFactory
         $resourceMetadata = $resourceMetadata->withItemOperations([
-            'get' => ['method' => 'GET'],
+            'get' => ['method' => 'GET', 'requirements' => ['id' => '\d+']],
             'put' => ['method' => 'PUT'],
             'delete' => ['method' => 'DELETE'],
         ]);
         //custom operations
         $resourceMetadata = $resourceMetadata->withCollectionOperations([
-            'my_op' => ['method' => 'GET', 'controller' => 'some.service.name'], //with controller
+            'my_op' => ['method' => 'GET', 'controller' => 'some.service.name', 'requirements' => ['_format' => 'a valid format']], //with controller
             'my_second_op' => ['method' => 'POST'], //without controller, takes the default one
             'my_path_op' => ['method' => 'GET', 'path' => 'some/custom/path'], //custom path
         ]);
 
         $routeCollection = $this->getApiLoaderWithResourceMetadata($resourceMetadata)->load(null);
 
         $this->assertEquals(
-            $this->getRoute('/dummies/{id}.{_format}', 'api_platform.action.get_item', DummyEntity::class, 'get', ['GET']),
+            $this->getRoute('/dummies/{id}.{_format}', 'api_platform.action.get_item', DummyEntity::class, 'get', ['GET'], false, ['id' => '\d+']),
             $routeCollection->get('api_dummies_get_item')
         );
 
@@ -76,7 +76,7 @@ public function testApiLoader()
         );
 
         $this->assertEquals(
-            $this->getRoute('/dummies.{_format}', 'some.service.name', DummyEntity::class, 'my_op', ['GET'], true),
+            $this->getRoute('/dummies.{_format}', 'some.service.name', DummyEntity::class, 'my_op', ['GET'], true, ['_format' => 'a valid format']),
             $routeCollection->get('api_dummies_my_op_collection')
         );
 
@@ -261,7 +261,7 @@ private function getApiLoaderWithResourceMetadata(ResourceMetadata $resourceMeta
         return $apiLoader;
     }
 
-    private function getRoute(string $path, string $controller, string $resourceClass, string $operationName, array $methods, bool $collection = false): Route
+    private function getRoute(string $path, string $controller, string $resourceClass, string $operationName, array $methods, bool $collection = false, array $requirements = []): Route
     {
         return new Route(
             $path,
@@ -271,15 +271,15 @@ private function getRoute(string $path, string $controller, string $resourceClas
                 '_api_resource_class' => $resourceClass,
                 sprintf('_api_%s_operation_name', $collection ? 'collection' : 'item') => $operationName,
             ],
-            [],
+            $requirements,
             [],
             '',
             [],
             $methods
         );
     }
 
-    private function getSubresourceRoute(string $path, string $controller, string $resourceClass, string $operationName, array $context): Route
+    private function getSubresourceRoute(string $path, string $controller, string $resourceClass, string $operationName, array $context, array $requirements = []): Route
     {
         return new Route(
             $path,
@@ -290,7 +290,7 @@ private function getSubresourceRoute(string $path, string $controller, string $r
                 '_api_subresource_operation_name' => $operationName,
                 '_api_subresource_context' => $context,
             ],
-            [],
+            $requirements,
             [],
             '',
             [],