Add non-regression test

Author: vincentchalamon

features/swagger/docs.feature

@@ -9,6 +9,10 @@ Feature: Documentation support
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json; charset=utf-8"
+    # OverrideDocumentationNormalizer
+    And the JSON node "definitions.RamseyUuidDummy.properties.id.description" should be equal to "The dummy id"
+    And the JSON node "definitions.RelatedDummy-barcelona" should exist
+    And the JSON node "definitions.RelatedDummybarcelona" should not exist
     # Context
     And the JSON node "swagger" should be equal to "2.0"
     # Root properties
@@ -110,4 +114,6 @@ Feature: Documentation support
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json; charset=utf-8"
     And the JSON node "basePath" should be equal to "/"
-    And the JSON node "info.version" should be equal to "1.0.0"
+    And the JSON node "definitions.RamseyUuidDummy.properties.id.description" should be equal to "The dummy id"
+    And the JSON node "definitions.RelatedDummy-barcelona" should not exist
+    And the JSON node "definitions.RelatedDummybarcelona" should exist

src/Bridge/Symfony/Bundle/Command/SwaggerCommand.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Documentation\Documentation;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use ApiPlatform\Core\Swagger\Serializer\ApiGatewayNormalizer;
 use ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\InvalidOptionException;
@@ -62,7 +63,8 @@ protected function configure()
             ->setDescription('Dump the OpenAPI documentation')
             ->addOption('yaml', 'y', InputOption::VALUE_NONE, 'Dump the documentation in YAML')
             ->addOption('spec-version', null, InputOption::VALUE_OPTIONAL, 'OpenAPI version to use ("2" or "3")', '2')
-            ->addOption('output', 'o', InputOption::VALUE_OPTIONAL, 'Write output to file');
+            ->addOption('output', 'o', InputOption::VALUE_OPTIONAL, 'Write output to file')
+            ->addOption('api-gateway', null, InputOption::VALUE_NONE, 'API Gateway compatibility');
     }
 
     /**
@@ -79,7 +81,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->apiTitle, $this->apiDescription, $this->apiVersion, $this->apiFormats);
-        $data = $this->normalizer->normalize($documentation, DocumentationNormalizer::FORMAT, ['spec_version' => (int) $version]);
+        $data = $this->normalizer->normalize($documentation, DocumentationNormalizer::FORMAT, ['spec_version' => (int) $version, ApiGatewayNormalizer::API_GATEWAY => $input->getOption('api-gateway')]);
         $content = $input->getOption('yaml') ? Yaml::dump($data, 10, 2, Yaml::DUMP_OBJECT_AS_MAP | Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE | Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK) : (json_encode($data, JSON_PRETTY_PRINT) ?: '');
 
         if (!empty($filename = $input->getOption('output')) && \is_string($filename)) {

tests/Bridge/Symfony/Bundle/Command/SwaggerCommandTest.php

@@ -85,7 +85,7 @@ public function testExecuteWithYamlVersion3()
         $expected = <<<YAML
 info:
   title: 'My Dummy API'
-  version: 1.0.0
+  version: 0.0.0
   description: |
     This is a test API.
     Made with love

tests/Fixtures/TestBundle/Serializer/Normalizer/OverrideDocumentationNormalizer.php

@@ -30,7 +30,11 @@ public function __construct(NormalizerInterface $documentationNormalizer)
     public function normalize($object, $format = null, array $context = [])
     {
         $data = $this->documentationNormalizer->normalize($object, $format, $context);
-        $data['info']['version'] = '1.0.0';
+        if (isset($data['definitions'])) {
+            $data['definitions']['RamseyUuidDummy']['properties']['id']['description'] = 'The dummy id';
+        } else {
+            $data['components']['schemas']['RamseyUuidDummy']['properties']['id']['description'] = 'The dummy id';
+        }
 
         return $data;
     }