fix: multiple error routes #6214 (#6263)

api-platform · Mar 29, 2024 · 4adc075 · 4adc075
1 parent cf20566
commit 4adc075
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 3 deletions.
diff --git a/src/Hydra/Serializer/DocumentationNormalizer.php b/src/Hydra/Serializer/DocumentationNormalizer.php
@@ -20,6 +20,7 @@
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\CollectionOperationInterface;
+use ApiPlatform\Metadata\ErrorResource;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
@@ -29,6 +30,7 @@
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Serializer\CacheableSupportsMethodInterface;
+use ApiPlatform\Symfony\Validator\Exception\ValidationException;
 use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
@@ -60,6 +62,10 @@ public function normalize(mixed $object, ?string $format = null, array $context
             $resourceMetadataCollection = $this->resourceMetadataFactory->create($resourceClass);
 
             $resourceMetadata = $resourceMetadataCollection[0];
+            if ($resourceMetadata instanceof ErrorResource && ValidationException::class === $resourceMetadata->getClass()) {
+                continue;
+            }
+
             $shortName = $resourceMetadata->getShortName();
             $prefixedShortName = $resourceMetadata->getTypes()[0] ?? "#$shortName";
             $this->populateEntrypointProperties($resourceMetadata, $shortName, $prefixedShortName, $entrypointProperties, $resourceMetadataCollection);

diff --git a/src/Metadata/Resource/Factory/OperationDefaultsTrait.php b/src/Metadata/Resource/Factory/OperationDefaultsTrait.php
@@ -202,7 +202,7 @@ private function getOperationWithDefaults(ApiResource $resource, Operation $oper
             throw new RuntimeException(sprintf('Operation should be an instance of "%s"', HttpOperation::class));
         }
 
-        if ($operation->getRouteName()) {
+        if (!$operation->getName() && $operation->getRouteName()) {
             /** @var HttpOperation $operation */
             $operation = $operation->withName($operation->getRouteName());
         }

diff --git a/src/Metadata/Resource/Factory/UriTemplateResourceMetadataCollectionFactory.php b/src/Metadata/Resource/Factory/UriTemplateResourceMetadataCollectionFactory.php
@@ -75,7 +75,7 @@ public function create(string $resourceClass): ResourceMetadataCollection
                         $operation = $operation->withName($routeName);
                     }
 
-                    $operations->add($routeName, $operation);
+                    $operations->add($operation->getName(), $operation);
                     continue;
                 }
 

diff --git a/src/State/ApiResource/Error.php b/src/State/ApiResource/Error.php
@@ -33,6 +33,7 @@
     operations: [
         new Operation(
             name: '_api_errors_problem',
+            routeName: 'api_errors',
             outputFormats: ['json' => ['application/problem+json']],
             normalizationContext: [
                 'groups' => ['jsonproblem'],
@@ -42,6 +43,7 @@
         ),
         new Operation(
             name: '_api_errors_hydra',
+            routeName: 'api_errors',
             outputFormats: ['jsonld' => ['application/problem+json']],
             normalizationContext: [
                 'groups' => ['jsonld'],
@@ -52,13 +54,18 @@
         ),
         new Operation(
             name: '_api_errors_jsonapi',
+            routeName: 'api_errors',
             outputFormats: ['jsonapi' => ['application/vnd.api+json']],
             normalizationContext: [
                 'groups' => ['jsonapi'],
                 'skip_null_values' => true,
                 'rfc_7807_compliant_errors' => true,
             ],
         ),
+        new Operation(
+            name: '_api_errors',
+            routeName: 'api_errors'
+        ),
     ],
     provider: 'api_platform.state.error_provider',
     graphQlOperations: []
@@ -120,12 +127,14 @@ public static function createFromException(\Exception|\Throwable $exception, int
     }
 
     #[Ignore]
+    #[ApiProperty(readable: false)]
     public function getHeaders(): array
     {
         return $this->headers;
     }
 
     #[Ignore]
+    #[ApiProperty(readable: false)]
     public function getStatusCode(): int
     {
         return $this->status;

diff --git a/src/Symfony/Bundle/Resources/config/routing/api.xml b/src/Symfony/Bundle/Resources/config/routing/api.xml
@@ -14,4 +14,15 @@
         <requirement key="index">index</requirement>
     </route>
 
+    <route id="api_errors" path="/errors/{status}">
+        <default key="_controller">api_platform.action.not_exposed</default>
+        <default key="status">500</default>
+
+        <requirement key="status">\d+</requirement>
+    </route>
+
+    <route id="api_validation_errors" path="/validation_errors/{id}">
+        <default key="_controller">api_platform.action.not_exposed</default>
+    </route>
+
 </routes>
diff --git a/src/Symfony/Routing/IriConverter.php b/src/Symfony/Routing/IriConverter.php
@@ -186,7 +186,9 @@ private function generateSymfonyRoute(object|string $resource, int $referenceTyp
         }
 
         try {
-            return $this->router->generate($operation->getName(), $identifiers, $operation->getUrlGenerationStrategy() ?? $referenceType);
+            $routeName = $operation instanceof HttpOperation ? ($operation->getRouteName() ?? $operation->getName()) : $operation->getName();
+
+            return $this->router->generate($routeName, $identifiers, $operation->getUrlGenerationStrategy() ?? $referenceType);
         } catch (RoutingExceptionInterface $e) {
             throw new InvalidArgumentException(sprintf('Unable to generate an IRI for the item of type "%s"', $operation->getClass()), $e->getCode(), $e);
         }

diff --git a/src/Symfony/Validator/Exception/ValidationException.php b/src/Symfony/Validator/Exception/ValidationException.php
@@ -40,13 +40,15 @@
     operations: [
         new ErrorOperation(
             name: '_api_validation_errors_problem',
+            routeName: 'api_validation_errors',
             outputFormats: ['json' => ['application/problem+json']],
             normalizationContext: ['groups' => ['json'],
                 'skip_null_values' => true,
                 'rfc_7807_compliant_errors' => true,
             ]),
         new ErrorOperation(
             name: '_api_validation_errors_hydra',
+            routeName: 'api_validation_errors',
             outputFormats: ['jsonld' => ['application/problem+json']],
             links: [new Link(rel: ContextBuilderInterface::JSONLD_NS.'error', href: 'http://www.w3.org/ns/hydra/error')],
             normalizationContext: [
@@ -57,9 +59,14 @@
         ),
         new ErrorOperation(
             name: '_api_validation_errors_jsonapi',
+            routeName: 'api_validation_errors',
             outputFormats: ['jsonapi' => ['application/vnd.api+json']],
             normalizationContext: ['groups' => ['jsonapi'], 'skip_null_values' => true, 'rfc_7807_compliant_errors' => true]
         ),
+        new ErrorOperation(
+            name: '_api_validation_errors',
+            routeName: 'api_validation_errors'
+        ),
     ],
     graphQlOperations: []
 )]