fix(symfony): force json format with GraphQL

api-platform · Oct 17, 2023 · 05363d9 · 05363d9
1 parent dbd4f64
commit 05363d9
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php b/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php
@@ -127,6 +127,11 @@ public function load(array $configs, ContainerBuilder $container): void
             $errorFormats['json'] = ['application/problem+json', 'application/json'];
         }
 
+        if ($this->isConfigEnabled($container, $config['graphql']) && !isset($formats['json'])) {
+            trigger_deprecation('api-platform/core', '3.2', 'Add the "json" format to the configuration to use GraphQL.');
+            $formats['json'] = ['application/json'];
+        }
+
         // Backward Compatibility layer
         if (isset($formats['jsonapi']) && !isset($patchFormats['jsonapi'])) {
             $patchFormats['jsonapi'] = ['application/vnd.api+json'];

diff --git a/tests/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php b/tests/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php
@@ -88,6 +88,7 @@ class ApiPlatformExtensionTest extends TestCase
         'description' => 'description',
         'version' => 'version',
         'formats' => [
+            'json' => ['mime_types' => ['json']],
             'jsonld' => ['mime_types' => ['application/ld+json']],
             'jsonhal' => ['mime_types' => ['application/hal+json']],
         ],
@@ -1260,4 +1261,17 @@ public function testHasClassMetadataCache(): void
 
         $this->assertFalse($this->container->hasDefinition('api_platform.serializer.mapping.cache_class_metadata_factory'));
     }
+
+    /**
+     * @group legacy
+     */
+    public function testLegacyGraphQlConfigurationWithoutJsonFormat(): void
+    {
+        $this->expectDeprecation('Since api-platform/core 3.2: Add the "json" format to the configuration to use GraphQL.');
+        $config = self::DEFAULT_CONFIG;
+        unset($config['api_platform']['formats']['json']);
+
+        (new ApiPlatformExtension())->load($config, $this->container);
+        $this->assertArrayHasKey('json', $this->container->getParameter('api_platform.formats'));
+    }
 }