Allow to specify a route prefix per resource (#1685)

* Allow to specify a route prefix per resource

* Move routePrefix to attributes

* CS

* Sanitize path as Symfony does internally too

Author: Toflar

src/Bridge/Symfony/Routing/ApiLoader.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Core\Exception\RuntimeException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
 use ApiPlatform\Core\PathResolver\OperationPathResolverInterface;
 use Symfony\Component\Config\FileLocator;
@@ -91,13 +92,13 @@ public function load($data, $type = null): RouteCollection
 
             if (null !== $collectionOperations = $resourceMetadata->getCollectionOperations()) {
                 foreach ($collectionOperations as $operationName => $operation) {
-                    $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceShortName, OperationType::COLLECTION);
+                    $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::COLLECTION);
                 }
             }
 
             if (null !== $itemOperations = $resourceMetadata->getItemOperations()) {
                 foreach ($itemOperations as $operationName => $operation) {
-                    $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceShortName, OperationType::ITEM);
+                    $this->addRoute($routeCollection, $resourceClass, $operationName, $operation, $resourceMetadata, OperationType::ITEM);
                 }
             }
 
@@ -170,17 +171,12 @@ private function loadExternalFiles(RouteCollection $routeCollection)
     /**
      * Creates and adds a route for the given operation to the route collection.
      *
-     * @param RouteCollection $routeCollection
-     * @param string          $resourceClass
-     * @param string          $operationName
-     * @param array           $operation
-     * @param string          $resourceShortName
-     * @param string          $operationType
-     *
      * @throws RuntimeException
      */
-    private function addRoute(RouteCollection $routeCollection, string $resourceClass, string $operationName, array $operation, string $resourceShortName, string $operationType)
+    private function addRoute(RouteCollection $routeCollection, string $resourceClass, string $operationName, array $operation, ResourceMetadata $resourceMetadata, string $operationType)
     {
+        $resourceShortName = $resourceMetadata->getShortName();
+
         if (isset($operation['route_name'])) {
             return;
         }
@@ -197,8 +193,11 @@ private function addRoute(RouteCollection $routeCollection, string $resourceClas
             }
         }
 
+        $path = trim(trim($resourceMetadata->getAttribute('routePrefix', '')), '/');
+        $path .= $this->operationPathResolver->resolveOperationPath($resourceShortName, $operation, $operationType, $operationName);
+
         $route = new Route(
-            $this->operationPathResolver->resolveOperationPath($resourceShortName, $operation, $operationType, $operationName),
+            $path,
             [
                 '_controller' => $controller,
                 '_format' => null,

tests/Annotation/AnnotatedClass.php

@@ -23,7 +23,7 @@
  *     itemOperations={"foo":{"bar"}},
  *     collectionOperations={"bar":{"foo"}},
  *     graphql={"query"={"normalization_context"={"groups"={"foo", "bar"}}}},
- *     attributes={"foo":"bar"}
+ *     attributes={"foo":"bar", "routePrefix"="/whatever"},
  * )
  *
  * @author Marcus Speight <marcus@pmconnect.co.uk>

tests/Annotation/ApiResourceTest.php

@@ -51,6 +51,6 @@ public function testApiResourceAnnotation()
         $this->assertSame('http://example.com/res', $resource->iri);
         $this->assertSame(['bar' => ['foo']], $resource->collectionOperations);
         $this->assertSame(['query' => ['normalization_context' => ['groups' => ['foo', 'bar']]]], $resource->graphql);
-        $this->assertSame(['foo' => 'bar'], $resource->attributes);
+        $this->assertSame(['foo' => 'bar', 'routePrefix' => '/whatever'], $resource->attributes);
     }
 }

tests/Bridge/Symfony/Routing/ApiLoaderTest.php

@@ -97,6 +97,35 @@ public function testApiLoader()
         );
     }
 
+    public function testApiLoaderWithPrefix()
+    {
+        $resourceMetadata = new ResourceMetadata();
+        $resourceMetadata = $resourceMetadata->withShortName('dummy');
+        $resourceMetadata = $resourceMetadata->withItemOperations([
+            'get' => ['method' => 'GET', 'requirements' => ['id' => '\d+'], 'defaults' => ['my_default' => 'default_value', '_controller' => 'should_not_be_overriden']],
+            'put' => ['method' => 'PUT'],
+            'delete' => ['method' => 'DELETE'],
+        ]);
+        $resourceMetadata = $resourceMetadata->withAttributes(['routePrefix' => '/foobar-prefix']);
+
+        $routeCollection = $this->getApiLoaderWithResourceMetadata($resourceMetadata)->load(null);
+
+        $this->assertEquals(
+            $this->getRoute('/foobar-prefix/dummies/{id}.{_format}', 'api_platform.action.get_item', DummyEntity::class, 'get', ['GET'], false, ['id' => '\d+'], ['my_default' => 'default_value']),
+            $routeCollection->get('api_dummies_get_item')
+        );
+
+        $this->assertEquals(
+            $this->getRoute('/foobar-prefix/dummies/{id}.{_format}', 'api_platform.action.delete_item', DummyEntity::class, 'delete', ['DELETE']),
+            $routeCollection->get('api_dummies_delete_item')
+        );
+
+        $this->assertEquals(
+            $this->getRoute('/foobar-prefix/dummies/{id}.{_format}', 'api_platform.action.put_item', DummyEntity::class, 'put', ['PUT']),
+            $routeCollection->get('api_dummies_put_item')
+        );
+    }
+
     /**
      * @expectedException \RuntimeException
      */

tests/Metadata/Resource/Factory/AnnotationResourceMetadataFactoryTest.php

@@ -43,7 +43,7 @@ public function testCreate(ProphecyInterface $reader, ProphecyInterface $decorat
         $this->assertEquals(['foo' => ['bar' => true]], $metadata->getItemOperations());
         $this->assertEquals(['baz' => ['tab' => false]], $metadata->getCollectionOperations());
         $this->assertEquals(['sub' => ['bus' => false]], $metadata->getSubresourceOperations());
-        $this->assertEquals(['a' => 1], $metadata->getAttributes());
+        $this->assertEquals(['a' => 1, 'routePrefix' => '/foobar'], $metadata->getAttributes());
         $this->assertEquals(['foo' => 'bar'], $metadata->getGraphql());
     }
 
@@ -56,7 +56,7 @@ public function getCreateDependencies()
         $annotation->itemOperations = ['foo' => ['bar' => true]];
         $annotation->collectionOperations = ['baz' => ['tab' => false]];
         $annotation->subresourceOperations = ['sub' => ['bus' => false]];
-        $annotation->attributes = ['a' => 1];
+        $annotation->attributes = ['a' => 1, 'routePrefix' => '/foobar'];
         $annotation->graphql = ['foo' => 'bar'];
 
         $reader = $this->prophesize(Reader::class);