Added documentation, tests and some cleanup

Author: harmbandstra

README.md

@@ -129,6 +129,13 @@ hb_swagger_ui:
     - "my_other_swagger_spec.json"
 ```
 
+Optional: If you want to have a default configuration in place for Swagger UI, place a `config.json` in the same directory as the swagger files, and add it to the configuration. It will be loaded automatically by appending it as the query parameter `configUrl`.
+
+```yaml
+hb_swagger_ui:
+  configFile: "config.json"
+```
+
 Optional: If you serve your project from a different directory than the vhost root, you can overwrite the asset URL path with the `assetUrlPath` configuration. Be sure to add a leading and trailing slash.
 
 ```yaml

src/Controller/DocsController.php

@@ -13,9 +13,6 @@
 
 class DocsController extends AbstractController
 {
-    /** @var string */
-    private $projectDir;
-
     /** @var array */
     private $swaggerFiles;
 
@@ -25,12 +22,11 @@ class DocsController extends AbstractController
     /** @var string */
     private $assetUrlPath;
 
-    /** @var string */
+    /** @var string|null */
     private $configFile;
 
-    public function __construct($projectDir, $swaggerFiles, $directory, $assetUrlPath, $configFile)
+    public function __construct($swaggerFiles, $directory, $assetUrlPath, $configFile)
     {
-        $this->projectDir = $projectDir;
         $this->swaggerFiles = $swaggerFiles;
         $this->directory = $directory;
         $this->assetUrlPath = $assetUrlPath;
@@ -44,15 +40,18 @@ public function __construct($projectDir, $swaggerFiles, $directory, $assetUrlPat
      */
     public function indexAction(Request $request)
     {
-        if (!$request->get('url') || (!$request->get('configUrl') && $this->configFile)) {
+        if (!$request->get('url')) {
             // if there is no ?url=... parameter, redirect to the default one
-            $specFile = reset($this->swaggerFiles);
+            $defaultSwaggerFile = reset($this->swaggerFiles);
 
-            return $this->redirect($this->getRedirectUrlToSpec($specFile, $request->get('url')));
+            return $this->redirect($this->getRedirectUrlToSpec($defaultSwaggerFile));
         }
         $contents = @file_get_contents(__DIR__ . '/../Resources/public/index.html');
         if ($contents === false) {
-            throw new \RuntimeException('Unable to load [Resources/public/index.html]. Did [ScriptHandler::linkAssets] run correctly?');
+            return new Response(
+                'Unable to load [Resources/public/index.html]. Did [ScriptHandler::linkAssets] run correctly?',
+                Response::HTTP_INTERNAL_SERVER_ERROR
+            );
         }
 
         return new Response($contents);
@@ -110,10 +109,12 @@ public function swaggerFileAction($fileName)
      */
     private function getFilePath($fileName = '')
     {
-        if ($fileName !== '' && !in_array($fileName, $this->swaggerFiles)) {
-            throw new \RuntimeException(
-                sprintf('File [%s] not defined under [hb_swagger_ui.files] in config.yml.', $fileName)
-            );
+        if ($this->configFile !== $fileName) {
+            if ($fileName !== '' && !in_array($fileName, $this->swaggerFiles)) {
+                throw new \RuntimeException(
+                    sprintf('File [%s] not defined under [hb_swagger_ui.files] in config.yml.', $fileName)
+                );
+            }
         }
 
         if ($this->directory === '') {
@@ -135,27 +136,26 @@ private function getFilePath($fileName = '')
      *
      * @return string
      */
-    private function getRedirectUrlToSpec($fileName, $url = null)
+    private function getRedirectUrlToSpec($fileName)
     {
-        if ($url) {
-            $specUrl = $url;
+        if (strpos($fileName, '/') === 0 || preg_match('#http[s]?://#', $fileName)) {
+            // if absolute path or URL use it raw
+            $specUrl = $fileName;
         } else {
-            if (strpos($fileName, '/') === 0 || preg_match('#http[s]?://#', $fileName)) {
-                // if absolute path or URL use it raw
-                $specUrl = $fileName;
-            } else {
-                $specUrl = $this->generateUrl(
-                    'hb_swagger_ui_swagger_file',
-                    ['fileName' => $fileName],
-                    UrlGeneratorInterface::ABSOLUTE_PATH
-                );
-            }
+            $specUrl = $this->generateUrl(
+                'hb_swagger_ui_swagger_file',
+                ['fileName' => $fileName],
+                UrlGeneratorInterface::ABSOLUTE_PATH
+            );
         }
 
         $parameters = ['url' => $specUrl];
-
         if ($this->configFile) {
-            $parameters['configUrl'] = $this->configFile;
+            $parameters['configUrl'] = $this->generateUrl(
+                'hb_swagger_ui_swagger_file',
+                ['fileName' => $this->configFile],
+                UrlGeneratorInterface::ABSOLUTE_PATH
+            );
         }
 
         return $this->generateUrl('hb_swagger_ui_default', $parameters);

src/Resources/config/services.yml

@@ -5,7 +5,6 @@ services:
     public: true
     tags: ['controller.service_arguments']
     bind:
-      $projectDir: '%kernel.project_dir%'
       $swaggerFiles: '%hb_swagger_ui.files%'
       $directory: '%hb_swagger_ui.directory%'
       $assetUrlPath: '%hb_swagger_ui.assetUrlPath%'

tests/Controller/DocsControllerTest.php

@@ -2,6 +2,7 @@
 
 namespace HarmBandstra\SwaggerUiBundle\Tests\Controller;
 
+use HarmBandstra\SwaggerUiBundle\Controller\DocsController;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Yaml\Yaml;
@@ -17,6 +18,26 @@ public function testIndex()
         $this->assertEquals(Response::HTTP_MOVED_PERMANENTLY, $response->getStatusCode());
     }
 
+    public function testIndexRedirectsProperly()
+    {
+        $client = static::createClient();
+        $client->followRedirects(true);
+        $client->request('GET', '/docs');
+
+        $uri = $client->getInternalRequest()->getUri();
+        $parsedUrl = parse_url($uri);
+
+        $this->assertSame('/docs/', $parsedUrl['path']);
+        $this->assertSame('url=/docs/file/petstore.json&configUrl=/docs/file/config.json', $parsedUrl['query']);
+
+        $response = $client->getResponse();
+        $this->assertEquals(Response::HTTP_INTERNAL_SERVER_ERROR, $response->getStatusCode());
+        $this->assertSame(
+            'Unable to load [Resources/public/index.html]. Did [ScriptHandler::linkAssets] run correctly?',
+            $response->getContent()
+        );
+    }
+
     public function testIndexWithTrailingSlash()
     {
         $client = static::createClient();
@@ -94,4 +115,31 @@ public function testIfSwaggerFileReturnsErrorOnFileNotFound()
             $response->getContent()
         );
     }
+
+    public function testIfConfigFileCanBeLoaded()
+    {
+        $client = static::createClient();
+        $client->request('GET', '/docs/file/config.json');
+
+        $response = $client->getResponse();
+        $this->assertEquals(Response::HTTP_OK, $response->getStatusCode());
+    }
+
+    public function testIfConfigFileReturnsFileNotFoundWhenNoConfigFileIsSet()
+    {
+        $docsController = new DocsController(
+            ["petstore.json", "petstore.yaml", "not_found.yaml"],
+            __DIR__ . "../../tests/Resources/docs/",
+            null,
+            null
+        );
+
+        $response = $docsController->swaggerFileAction('config.json');
+
+        $this->assertEquals(Response::HTTP_NOT_FOUND, $response->getStatusCode());
+        $this->assertEquals(
+            '"File [config.json] not defined under [hb_swagger_ui.files] in config.yml."',
+            $response->getContent()
+        );
+    }
 }