Support YAML output from SwaggerCommand with --yaml

Author: dkarlovi

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

@@ -17,8 +17,10 @@
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+use Symfony\Component\Yaml\Yaml;
 
 /**
  * Console command to dump Swagger API documentations.
@@ -53,7 +55,8 @@ protected function configure()
     {
         $this
             ->setName('api:swagger:export')
-            ->setDescription('Dump the Swagger 2.0 (OpenAPI) documentation');
+            ->setDescription('Dump the Swagger 2.0 (OpenAPI) documentation')
+            ->addOption('yaml', 'y', InputOption::VALUE_NONE, 'Dump the documentation in YAML');
     }
 
     /**
@@ -63,7 +66,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->apiTitle, $this->apiDescription, $this->apiVersion, $this->apiFormats);
         $data = $this->documentationNormalizer->normalize($documentation);
-        $content = json_encode($data, JSON_PRETTY_PRINT);
+        if ($input->getOption('yaml')) {
+            $content = Yaml::dump($data);
+        } else {
+            $content = json_encode($data, JSON_PRETTY_PRINT);
+        }
         $output->writeln($content);
     }
 }

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

@@ -16,23 +16,54 @@
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\Console\Tester\ApplicationTester;
+use Symfony\Component\Yaml\Exception\ParseException;
+use Symfony\Component\Yaml\Yaml;
 
 /**
  * @author Amrouche Hamza <[email protected]>
  */
 class SwaggerCommandTest extends KernelTestCase
 {
-    public function testExecute()
+    /**
+     * @var ApplicationTester
+     */
+    private $tester;
+
+    protected function setUp()
     {
         self::bootKernel();
 
         $application = new Application(static::$kernel);
         $application->setCatchExceptions(false);
         $application->setAutoExit(false);
 
-        $tester = new ApplicationTester($application);
-        $tester->run(['command' => 'api:swagger:export']);
+        $this->tester = new ApplicationTester($application);
+    }
 
-        $this->assertJson($tester->getDisplay());
+    public function testExecute()
+    {
+        $this->tester->run(['command' => 'api:swagger:export']);
+
+        $this->assertJson($this->tester->getDisplay());
+    }
+
+    public function testExecuteWithYaml()
+    {
+        $this->tester->run(['command' => 'api:swagger:export', '--yaml' => true]);
+
+        $this->assertYaml($this->tester->getDisplay());
+    }
+
+    /**
+     * @param string $data
+     */
+    private function assertYaml($data)
+    {
+        try {
+            Yaml::parse($data);
+        } catch (ParseException $exception) {
+            $this->fail('Is not valid YAML: '.$exception->getMessage());
+        }
+        $this->addToAssertionCount(1);
     }
 }