Correct prefix path swagger subresources

Author: abluchet

src/Bridge/Symfony/Routing/RouterOperationPathResolver.php

@@ -53,7 +53,7 @@ public function resolveOperationPath(string $resourceShortName, array $operation
         if (isset($operation['route_name'])) {
             $routeName = $operation['route_name'];
         } elseif (OperationType::SUBRESOURCE === $operationType) {
-            throw new InvalidArgumentException('Subresource operations are not supported by the RouterOperationPathResolver.');
+            throw new InvalidArgumentException('Subresource operations are not supported by the RouterOperationPathResolver without a route name.');
         } else {
             if (null !== $operationName) {
                 $routeName = RouteNameGenerator::generate($operationName, $resourceShortName, $operationType);

src/Operation/PathSegmentNameGeneratorInterface.php

@@ -23,7 +23,7 @@ interface PathSegmentNameGeneratorInterface
     /**
      * Transforms a given string to a valid path name which can be pluralized (eg. for collections).
      *
-     * @param string $name      usually a ResourceMetadata shortname
+     * @param string $name       usually a ResourceMetadata shortname
      * @param bool   $collection
      *
      * @return string A string that is a part of the route name

src/Swagger/Serializer/DocumentationNormalizer.php

@@ -25,7 +25,6 @@
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
-use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactory;
 use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
 use ApiPlatform\Core\PathResolver\OperationPathResolverInterface;
 use Psr\Container\ContainerInterface;
@@ -140,7 +139,7 @@ public function normalize($object, $format = null, array $context = [])
                     }
                 }
 
-                $paths[str_replace(SubresourceOperationFactory::FORMAT_SUFFIX, '', $subresourceOperation['path'])] = new \ArrayObject(['get' => $pathOperation]);
+                $paths[$this->getPath($subresourceOperation['shortNames'][0], $subresourceOperation['route_name'], $subresourceOperation, OperationType::SUBRESOURCE)] = new \ArrayObject(['get' => $pathOperation]);
             }
         }
 

tests/PathResolver/CustomOperationPathResolverTest.php

@@ -19,7 +19,6 @@
 
 /**
  * @author Baptiste Meyer <[email protected]>
- * @group legacy
  */
 class CustomOperationPathResolverTest extends \PHPUnit_Framework_TestCase
 {
@@ -41,6 +40,7 @@ public function testResolveOperationPathWithDeferred()
     }
 
     /**
+     * @group legacy
      * @expectedDeprecation Using a boolean for the Operation Type is deprecrated since API Platform 2.1 and will not be possible anymore in API Platform 3
      */
     public function testLegacyResolveOperationPath()

tests/Swagger/Serializer/DocumentationNormalizerTest.php

@@ -17,6 +17,7 @@
 use ApiPlatform\Core\Api\OperationMethodResolverInterface;
 use ApiPlatform\Core\Api\ResourceClassResolverInterface;
 use ApiPlatform\Core\Api\UrlGeneratorInterface;
+use ApiPlatform\Core\Bridge\Symfony\Routing\RouterOperationPathResolver;
 use ApiPlatform\Core\Documentation\Documentation;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
@@ -41,6 +42,9 @@
 use Prophecy\Argument;
 use Psr\Container\ContainerInterface;
 use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**
@@ -1507,7 +1511,14 @@ public function testNormalizeWithSubResource()
         $operationMethodResolverProphecy = $this->prophesize(OperationMethodResolverInterface::class);
         $operationMethodResolverProphecy->getItemOperationMethod(Question::class, 'get')->shouldBeCalled()->willReturn('GET');
 
-        $operationPathResolver = new CustomOperationPathResolver(new OperationPathResolver(new UnderscorePathSegmentNameGenerator()));
+        $routeCollection = new RouteCollection();
+        $routeCollection->add('api_questions_answer_get_subresource', new Route('/api/questions/{id}/answer.{_format}'));
+        $routeCollection->add('api_questions_get_item', new Route('/api/questions/{id}.{_format}'));
+
+        $routerProphecy = $this->prophesize(RouterInterface::class);
+        $routerProphecy->getRouteCollection()->shouldBeCalled()->willReturn($routeCollection);
+
+        $operationPathResolver = new RouterOperationPathResolver($routerProphecy->reveal(), new CustomOperationPathResolver(new OperationPathResolver(new UnderscorePathSegmentNameGenerator())));
 
         $resourceMetadataFactory = $resourceMetadataFactoryProphecy->reveal();
         $propertyNameCollectionFactory = $propertyNameCollectionFactoryProphecy->reveal();
@@ -1535,7 +1546,7 @@ public function testNormalizeWithSubResource()
                 'version' => '1.2.3',
             ],
             'paths' => new \ArrayObject([
-                '/questions/{id}' => [
+                '/api/questions/{id}' => [
                     'get' => new \ArrayObject([
                         'tags' => ['Question'],
                         'operationId' => 'getQuestionItem',
@@ -1558,7 +1569,7 @@ public function testNormalizeWithSubResource()
                         ],
                     ]),
                 ],
-                '/questions/{id}/answer' => new \ArrayObject([
+                '/api/questions/{id}/answer' => new \ArrayObject([
                     'get' => new \ArrayObject([
                         'tags' => ['Answer', 'Question'],
                         'operationId' => 'ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Question-answer-ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Answer',