Merge pull request #3241 from soyuka/custom-swagger-ui-location

Allow changing the location of Swagger UI

Author: soyuka

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -320,13 +320,15 @@ private function registerSwaggerConfiguration(ContainerBuilder $container, array
 
         $loader->load('json_schema.xml');
         $loader->load('swagger.xml');
+        $loader->load('swagger-ui.xml');
 
-        if ($config['enable_swagger_ui'] || $config['enable_re_doc']) {
-            $loader->load('swagger-ui.xml');
-            $container->setParameter('api_platform.enable_swagger_ui', $config['enable_swagger_ui']);
-            $container->setParameter('api_platform.enable_re_doc', $config['enable_re_doc']);
+        if (!$config['enable_swagger_ui'] && !$config['enable_re_doc']) {
+            // Remove the listener but keep the controller to allow customizing the path of the UI
+            $container->removeDefinition('api_platform.swagger.listener.ui');
         }
 
+        $container->setParameter('api_platform.enable_swagger_ui', $config['enable_swagger_ui']);
+        $container->setParameter('api_platform.enable_re_doc', $config['enable_re_doc']);
         $container->setParameter('api_platform.swagger.api_keys', $config['swagger']['api_keys']);
     }
 

src/Bridge/Symfony/Bundle/Resources/views/SwaggerUi/index.html.twig

@@ -83,7 +83,7 @@
     {% if (reDocEnabled and not swaggerUiEnabled) or (reDocEnabled and 're_doc' == active_ui) %}
         <script src="{{ asset('bundles/apiplatform/redoc/redoc.standalone.js') }}"></script>
         <script src="{{ asset('bundles/apiplatform/init-redoc-ui.js') }}"></script>
-    {% elseif (swaggerUiEnabled) %}
+    {% else %}
         <script src="{{ asset('bundles/apiplatform/swagger-ui/swagger-ui-bundle.js') }}"></script>
         <script src="{{ asset('bundles/apiplatform/swagger-ui/swagger-ui-standalone-preset.js') }}"></script>
         <script src="{{ asset('bundles/apiplatform/init-swagger-ui.js') }}"></script>

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -518,13 +518,11 @@ public function testDisabledDocsRemovesAddLinkHeaderService()
     public function testDisabledSwaggerUIAndRedoc()
     {
         $containerBuilderProphecy = $this->getBaseContainerBuilderProphecy();
-        $containerBuilderProphecy->setDefinition('api_platform.swagger.action.ui', Argument::type(Definition::class))->shouldNotBeCalled();
-        $containerBuilderProphecy->setDefinition('api_platform.swagger.listener.ui', Argument::type(Definition::class))->shouldNotBeCalled();
-        $containerBuilderProphecy->setParameter('api_platform.enable_swagger_ui', true)->shouldNotBeCalled();
+        $containerBuilderProphecy->removeDefinition('api_platform.swagger.listener.ui')->shouldBeCalledTimes(1);
         $containerBuilderProphecy->setParameter('api_platform.enable_swagger_ui', true)->shouldNotBeCalled();
-        $containerBuilderProphecy->setParameter('api_platform.enable_swagger_ui', false)->shouldNotBeCalled();
+        $containerBuilderProphecy->setParameter('api_platform.enable_swagger_ui', false)->shouldBeCalledTimes(1);
         $containerBuilderProphecy->setParameter('api_platform.enable_re_doc', true)->shouldNotBeCalled();
-        $containerBuilderProphecy->setParameter('api_platform.enable_re_doc', false)->shouldNotBeCalled();
+        $containerBuilderProphecy->setParameter('api_platform.enable_re_doc', false)->shouldBeCalledTimes(1);
         $containerBuilder = $containerBuilderProphecy->reveal();
 
         $config = self::DEFAULT_CONFIG;