Update the export command

Author: antograssiot

.travis.yml

@@ -53,3 +53,5 @@ script:
     fi
   - tests/Fixtures/app/console api:swagger:export > swagger.json && npx swagger-cli validate swagger.json && rm swagger.json
   - tests/Fixtures/app/console api:swagger:export --yaml > swagger.yaml && npx swagger-cli validate swagger.yaml && rm swagger.yaml
+  - tests/Fixtures/app/console api:openapi:export --spec-version 3 > swagger.json && npx swagger-cli validate swagger.json && rm swagger.json
+  - tests/Fixtures/app/console api:openapi:export --spec-version 3 --yaml > swagger.yaml && npx swagger-cli validate swagger.yaml && rm swagger.yaml

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

@@ -16,6 +16,7 @@
 use ApiPlatform\Core\Documentation\Documentation;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Exception\InvalidOptionException;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -29,18 +30,20 @@
  */
 final class SwaggerCommand extends Command
 {
-    private $documentationNormalizer;
+    private $v2documentationNormalizer;
+    private $v3documentationNormalizer;
     private $resourceNameCollectionFactory;
     private $apiTitle;
     private $apiDescription;
     private $apiVersion;
     private $apiFormats;
 
-    public function __construct(NormalizerInterface $documentationNormalizer, ResourceNameCollectionFactoryInterface $resourceNameCollection, string $apiTitle, string $apiDescription, string $apiVersion, array $apiFormats)
+    public function __construct(NormalizerInterface $v2documentationNormalizer, NormalizerInterface $v3documentationNormalizer, ResourceNameCollectionFactoryInterface $resourceNameCollection, string $apiTitle, string $apiDescription, string $apiVersion, array $apiFormats)
     {
         parent::__construct();
 
-        $this->documentationNormalizer = $documentationNormalizer;
+        $this->v2documentationNormalizer = $v2documentationNormalizer;
+        $this->v3documentationNormalizer = $v3documentationNormalizer;
         $this->resourceNameCollectionFactory = $resourceNameCollection;
         $this->apiTitle = $apiTitle;
         $this->apiDescription = $apiDescription;
@@ -54,9 +57,11 @@ public function __construct(NormalizerInterface $documentationNormalizer, Resour
     protected function configure()
     {
         $this
-            ->setName('api:swagger:export')
-            ->setDescription('Dump the Swagger 2.0 (OpenAPI) documentation')
+            ->setName('api:openapi:export')
+            ->setAliases(['api:swagger:export'])
+            ->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');
     }
 
@@ -65,9 +70,15 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        /** @var string $version */
+        $version = $input->getOption('spec-version');
+        if (!\in_array($version, ['2', '3'], true)) {
+            throw new InvalidOptionException(sprintf('This tool only support version 2 and 3 of the OpenAPI specification ("%s" given).', $version));
+        }
+        $documentationNormalizer = sprintf('v%ddocumentationNormalizer', $version);
         $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->apiTitle, $this->apiDescription, $this->apiVersion, $this->apiFormats);
-        $data = $this->documentationNormalizer->normalize($documentation);
-        $content = $input->getOption('yaml') ? Yaml::dump($data, 6, 4, Yaml::DUMP_OBJECT_AS_MAP | Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE) : (json_encode($data, JSON_PRETTY_PRINT) ?: '');
+        $data = $this->$documentationNormalizer->normalize($documentation);
+        $content = $input->getOption('yaml') ? Yaml::dump($data, 10, 2, Yaml::DUMP_OBJECT_AS_MAP | Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE) : (json_encode($data, JSON_PRETTY_PRINT) ?: '');
         if (!empty($filename = $input->getOption('output')) && \is_string($filename)) {
             file_put_contents($filename, $content);
             $output->writeln(

src/Bridge/Symfony/Bundle/Resources/config/swagger.xml

@@ -67,12 +67,12 @@
 
         <service id="api_platform.swagger.command.swagger_command" class="ApiPlatform\Core\Bridge\Symfony\Bundle\Command\SwaggerCommand">
             <argument type="service" id="api_platform.swagger.normalizer.documentation" />
+            <argument type="service" id="api_platform.openapi.normalizer.documentation" />
             <argument type="service" id="api_platform.metadata.resource.name_collection_factory" />
             <argument>%api_platform.title%</argument>
             <argument>%api_platform.description%</argument>
             <argument>%api_platform.version%</argument>
             <argument>%api_platform.formats%</argument>
-
             <tag name="console.command" />
         </service>
 

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

@@ -15,6 +15,7 @@
 
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\Console\Exception\InvalidOptionException;
 use Symfony\Component\Console\Tester\ApplicationTester;
 use Symfony\Component\Yaml\Exception\ParseException;
 use Symfony\Component\Yaml\Yaml;
@@ -40,13 +41,20 @@ protected function setUp()
         $this->tester = new ApplicationTester($application);
     }
 
-    public function testExecute()
+    public function testExecuteWithAlias()
     {
         $this->tester->run(['command' => 'api:swagger:export']);
 
         $this->assertJson($this->tester->getDisplay());
     }
 
+    public function testExecuteOpenApiV3()
+    {
+        $this->tester->run(['command' => 'api:openapi:export', '--spec-version' => '3']);
+
+        $this->assertJson($this->tester->getDisplay());
+    }
+
     public function testExecuteWithYaml()
     {
         $this->tester->run(['command' => 'api:swagger:export', '--yaml' => true]);
@@ -55,23 +63,40 @@ public function testExecuteWithYaml()
         $this->assertYaml($result);
 
         $expected = <<<YAML
-    /dummy_cars:
-        get:
-            tags:
-                - DummyCar
-            operationId: getDummyCarCollection
+  /dummy_cars:
+    get:
+      tags:
+        - DummyCar
+      operationId: getDummyCarCollection
 YAML;
 
         $this->assertContains($expected, $result, 'nested object should be present.');
 
         $expected = <<<YAML
-    '/dummy_cars/{id}':
-        get:
-            tags: []
-            operationId: getDummyCarItem
+  '/dummy_cars/{id}':
+    get:
+      tags: []
+      operationId: getDummyCarItem
 YAML;
 
         $this->assertContains($expected, $result, 'arrays should be correctly formatted.');
+        $this->assertContains("swagger: '2.0'", $result);
+    }
+
+    public function testExecuteOpenApiV3WithYaml()
+    {
+        $this->tester->run(['command' => 'api:openapi:export', '--spec-version' => '3', '--yaml' => true]);
+
+        $result = $this->tester->getDisplay();
+        $this->assertYaml($result);
+        $this->assertContains('openapi: 3.0.2', $result);
+    }
+
+    public function testExecuteWithBadArguments()
+    {
+        $this->expectException(InvalidOptionException::class);
+        $this->expectExceptionMessage('This tool only support version 2 and 3 of the OpenAPI specification ("" given).');
+        $this->tester->run(['command' => 'api:openapi:export', '--spec-version' => '', '--yaml' => true]);
     }
 
     public function testWriteToFile()