From dc2db3af2c64af435b9f36e0db839ec28ada7bc3 Mon Sep 17 00:00:00 2001 From: Alan Poulain Date: Fri, 19 Feb 2021 17:04:06 +0100 Subject: [PATCH 1/4] Add doc_expansion and filter to swagger config --- .../Symfony/Bundle/Action/SwaggerUiAction.php | 11 ++++++++++- .../ApiPlatformExtension.php | 2 ++ .../DependencyInjection/Configuration.php | 14 ++++++++++++++ .../Bundle/Resources/config/swagger-ui.xml | 4 ++++ .../Resources/public/init-swagger-ui.js | 2 ++ .../Bundle/SwaggerUi/SwaggerUiAction.php | 2 ++ .../Bundle/SwaggerUi/SwaggerUiContext.php | 19 ++++++++++++++++++- .../Bundle/Action/SwaggerUiActionTest.php | 6 ++++++ .../ApiPlatformExtensionTest.php | 4 ++++ .../DependencyInjection/ConfigurationTest.php | 4 ++++ .../Bundle/SwaggerUi/SwaggerUiActionTest.php | 6 ++++++ 11 files changed, 72 insertions(+), 2 deletions(-) diff --git a/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php b/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php index d84a1b2214a..6129c0f27d6 100644 --- a/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php +++ b/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php @@ -62,12 +62,14 @@ final class SwaggerUiAction private $swaggerVersions; private $swaggerUiAction; private $assetPackage; + private $swaggerUiDocExpansion; + private $swaggerUiFilter; /** * @param int[] $swaggerVersions * @param mixed|null $assetPackage */ - public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '', string $version = '', $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthScopes = [], bool $showWebby = true, bool $swaggerUiEnabled = false, bool $reDocEnabled = false, bool $graphqlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, array $swaggerVersions = [2, 3], OpenApiSwaggerUiAction $swaggerUiAction = null, $assetPackage = null) + public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '', string $version = '', $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthScopes = [], bool $showWebby = true, bool $swaggerUiEnabled = false, bool $reDocEnabled = false, bool $graphqlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, array $swaggerVersions = [2, 3], OpenApiSwaggerUiAction $swaggerUiAction = null, $assetPackage = null, string $swaggerUiDocExpansion = 'list', bool $swaggerUiFilter = false) { $this->resourceNameCollectionFactory = $resourceNameCollectionFactory; $this->resourceMetadataFactory = $resourceMetadataFactory; @@ -99,6 +101,11 @@ public function __construct(ResourceNameCollectionFactoryInterface $resourceName @trigger_error(sprintf('The use of "%s" is deprecated since API Platform 2.6, use "%s" instead.', __CLASS__, OpenApiSwaggerUiAction::class), \E_USER_DEPRECATED); } + if (\in_array($swaggerUiDocExpansion, ['list', 'full', 'none'], true)) { + $this->swaggerUiDocExpansion = $swaggerUiDocExpansion; + } + $this->swaggerUiFilter = $swaggerUiFilter; + if (\is_array($formats)) { $this->formats = $formats; @@ -156,6 +163,8 @@ private function getContext(Request $request, Documentation $documentation): arr $swaggerData = [ 'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']), + 'docExpansion' => $this->swaggerUiDocExpansion, + 'filter' => $this->swaggerUiFilter, 'spec' => $this->normalizer->normalize($documentation, 'json', $swaggerContext), ]; diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php b/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php index c330c90905f..7e3e5cc905a 100644 --- a/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php +++ b/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php @@ -397,6 +397,8 @@ private function registerSwaggerConfiguration(ContainerBuilder $container, array $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']); + $container->setParameter('api_platform.swagger_ui.doc_expansion', $config['swagger']['ui']['doc_expansion']); + $container->setParameter('api_platform.swagger_ui.filter', $config['swagger']['ui']['filter']); if (true === $config['openapi']['backward_compatibility_layer']) { $container->getDefinition('api_platform.swagger.normalizer.documentation')->addArgument($container->getDefinition('api_platform.openapi.normalizer')); diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php b/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php index de9a01c80a8..457569c9d65 100644 --- a/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php +++ b/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php @@ -339,6 +339,20 @@ private function addSwaggerSection(ArrayNodeDefinition $rootNode): void ->end() ->end() ->end() + ->arrayNode('ui') + ->addDefaultsIfNotSet() + ->children() + ->enumNode('doc_expansion') + ->info("Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).") + ->values(['list', 'full', 'none']) + ->defaultValue('list') + ->end() + ->booleanNode('filter') + ->info('If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown.') + ->defaultFalse() + ->end() + ->end() + ->end() ->end() ->end() ->end(); diff --git a/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml b/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml index c56d3a3440c..e1121570675 100644 --- a/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml +++ b/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml @@ -38,6 +38,8 @@ %api_platform.swagger.versions% %api_platform.asset_package% + %api_platform.swagger_ui.doc_expansion% + %api_platform.swagger_ui.filter% @@ -48,6 +50,8 @@ %api_platform.graphql.graphiql.enabled% %api_platform.graphql.graphql_playground.enabled% %api_platform.asset_package% + %api_platform.swagger_ui.doc_expansion% + %api_platform.swagger_ui.filter% diff --git a/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js b/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js index 95f2b63ed5e..6ad77c6a95b 100644 --- a/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js +++ b/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js @@ -42,6 +42,8 @@ window.onload = function() { const data = JSON.parse(document.getElementById('swagger-data').innerText); const ui = SwaggerUIBundle({ + docExpansion: data.docExpansion, + filter: data.filter, spec: data.spec, dom_id: '#swagger-ui', validatorUrl: null, diff --git a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php index 81bf60ebb39..725f9c5ae6a 100644 --- a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php +++ b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php @@ -75,6 +75,8 @@ public function __invoke(Request $request) $swaggerData = [ 'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']), + 'docExpansion' => $this->swaggerUiContext->getDocExpansion(), + 'filter' => $this->swaggerUiContext->hasFilter(), 'spec' => $this->normalizer->normalize($openApi, 'json', []), 'oauth' => [ 'enabled' => $this->openApiOptions->getOAuthEnabled(), diff --git a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php index 29aaf205600..2a2a8f046ef 100644 --- a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php +++ b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php @@ -22,8 +22,10 @@ final class SwaggerUiContext private $graphiQlEnabled; private $graphQlPlaygroundEnabled; private $assetPackage; + private $docExpansion; + private $filter; - public function __construct(bool $swaggerUiEnabled = false, bool $showWebby = true, bool $reDocEnabled = false, bool $graphQlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, $assetPackage = null) + public function __construct(bool $swaggerUiEnabled = false, bool $showWebby = true, bool $reDocEnabled = false, bool $graphQlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, $assetPackage = null, string $docExpansion = 'list', bool $filter = false) { $this->swaggerUiEnabled = $swaggerUiEnabled; $this->showWebby = $showWebby; @@ -32,6 +34,11 @@ public function __construct(bool $swaggerUiEnabled = false, bool $showWebby = tr $this->graphiQlEnabled = $graphiQlEnabled; $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled; $this->assetPackage = $assetPackage; + + if (\in_array($docExpansion, ['list', 'full', 'none'], true)) { + $this->docExpansion = $docExpansion; + } + $this->filter = $filter; } public function isSwaggerUiEnabled(): bool @@ -68,4 +75,14 @@ public function getAssetPackage(): ?string { return $this->assetPackage; } + + public function getDocExpansion(): string + { + return $this->docExpansion; + } + + public function hasFilter(): bool + { + return $this->filter; + } } diff --git a/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php b/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php index ae1c6d3391d..5d3a15060d3 100644 --- a/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php +++ b/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php @@ -88,6 +88,8 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', + 'docExpansion' => 'list', + 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, @@ -122,6 +124,8 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', + 'docExpansion' => 'list', + 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, @@ -179,6 +183,8 @@ public function testDoNotRunCurrentRequest(Request $request) 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', + 'docExpansion' => 'list', + 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, diff --git a/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php b/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php index 38f379dd726..100f2c004bd 100644 --- a/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php +++ b/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php @@ -244,6 +244,8 @@ public function testSetNameConverter() $containerBuilderProphecy->hasParameter('kernel.debug')->willReturn(true); $containerBuilderProphecy->getParameter('kernel.debug')->willReturn(false); $containerBuilderProphecy->setAlias('api_platform.name_converter', $nameConverterId)->shouldBeCalled(); + $containerBuilderProphecy->setParameter('api_platform.swagger_ui.doc_expansion', 'list')->shouldBeCalled(); + $containerBuilderProphecy->setParameter('api_platform.swagger_ui.filter', false)->shouldBeCalled(); $containerBuilder = $containerBuilderProphecy->reveal(); @@ -1172,6 +1174,8 @@ private function getBaseContainerBuilderProphecy(array $doctrineIntegrationsToLo if ($hasSwagger) { $parameters['api_platform.swagger.versions'] = [2, 3]; $parameters['api_platform.swagger.api_keys'] = []; + $parameters['api_platform.swagger_ui.doc_expansion'] = 'list'; + $parameters['api_platform.swagger_ui.filter'] = false; } else { $parameters['api_platform.swagger.versions'] = []; } diff --git a/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php b/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php index 1df2208bb80..3af0a9e26d3 100644 --- a/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php +++ b/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php @@ -150,6 +150,10 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm 'swagger' => [ 'versions' => [2, 3], 'api_keys' => [], + 'ui' => [ + 'doc_expansion' => 'list', + 'filter' => false, + ], ], 'eager_loading' => [ 'enabled' => true, diff --git a/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php b/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php index f75315d9712..523c2bcb41b 100644 --- a/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php +++ b/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php @@ -88,6 +88,8 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', + 'docExpansion' => 'list', + 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, @@ -122,6 +124,8 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', + 'docExpansion' => 'list', + 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, @@ -174,6 +178,8 @@ public function testDoNotRunCurrentRequest(Request $request) 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', + 'docExpansion' => 'list', + 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, From a0b91498ed8d399108c57c2b6e285ae4175b7c1d Mon Sep 17 00:00:00 2001 From: Alan Poulain Date: Fri, 19 Feb 2021 17:36:39 +0100 Subject: [PATCH 2/4] Use ui_extra_configuration --- .../Symfony/Bundle/Action/SwaggerUiAction.php | 14 ++++--------- .../ApiPlatformExtension.php | 3 +-- .../DependencyInjection/Configuration.php | 18 ++++++----------- .../Bundle/Resources/config/swagger-ui.xml | 6 ++---- .../Resources/public/init-swagger-ui.js | 6 ++---- .../Bundle/SwaggerUi/SwaggerUiAction.php | 3 +-- .../Bundle/SwaggerUi/SwaggerUiContext.php | 20 +++++-------------- .../Bundle/Action/SwaggerUiActionTest.php | 9 +++------ .../ApiPlatformExtensionTest.php | 6 ++---- .../DependencyInjection/ConfigurationTest.php | 5 +---- .../Bundle/SwaggerUi/SwaggerUiActionTest.php | 9 +++------ 11 files changed, 30 insertions(+), 69 deletions(-) diff --git a/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php b/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php index 6129c0f27d6..5a03d2baffd 100644 --- a/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php +++ b/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php @@ -62,14 +62,13 @@ final class SwaggerUiAction private $swaggerVersions; private $swaggerUiAction; private $assetPackage; - private $swaggerUiDocExpansion; - private $swaggerUiFilter; + private $swaggerUiExtraConfiguration; /** * @param int[] $swaggerVersions * @param mixed|null $assetPackage */ - public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '', string $version = '', $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthScopes = [], bool $showWebby = true, bool $swaggerUiEnabled = false, bool $reDocEnabled = false, bool $graphqlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, array $swaggerVersions = [2, 3], OpenApiSwaggerUiAction $swaggerUiAction = null, $assetPackage = null, string $swaggerUiDocExpansion = 'list', bool $swaggerUiFilter = false) + public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '', string $version = '', $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthScopes = [], bool $showWebby = true, bool $swaggerUiEnabled = false, bool $reDocEnabled = false, bool $graphqlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, array $swaggerVersions = [2, 3], OpenApiSwaggerUiAction $swaggerUiAction = null, $assetPackage = null, array $swaggerUiExtraConfiguration = []) { $this->resourceNameCollectionFactory = $resourceNameCollectionFactory; $this->resourceMetadataFactory = $resourceMetadataFactory; @@ -95,17 +94,13 @@ public function __construct(ResourceNameCollectionFactoryInterface $resourceName $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled; $this->swaggerVersions = $swaggerVersions; $this->swaggerUiAction = $swaggerUiAction; + $this->swaggerUiExtraConfiguration = $swaggerUiExtraConfiguration; $this->assetPackage = $assetPackage; if (null === $this->swaggerUiAction) { @trigger_error(sprintf('The use of "%s" is deprecated since API Platform 2.6, use "%s" instead.', __CLASS__, OpenApiSwaggerUiAction::class), \E_USER_DEPRECATED); } - if (\in_array($swaggerUiDocExpansion, ['list', 'full', 'none'], true)) { - $this->swaggerUiDocExpansion = $swaggerUiDocExpansion; - } - $this->swaggerUiFilter = $swaggerUiFilter; - if (\is_array($formats)) { $this->formats = $formats; @@ -163,9 +158,8 @@ private function getContext(Request $request, Documentation $documentation): arr $swaggerData = [ 'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']), - 'docExpansion' => $this->swaggerUiDocExpansion, - 'filter' => $this->swaggerUiFilter, 'spec' => $this->normalizer->normalize($documentation, 'json', $swaggerContext), + 'extraConfiguration' => $this->swaggerUiExtraConfiguration, ]; $swaggerData['oauth'] = [ diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php b/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php index 7e3e5cc905a..df63ed8b36f 100644 --- a/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php +++ b/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php @@ -397,8 +397,7 @@ private function registerSwaggerConfiguration(ContainerBuilder $container, array $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']); - $container->setParameter('api_platform.swagger_ui.doc_expansion', $config['swagger']['ui']['doc_expansion']); - $container->setParameter('api_platform.swagger_ui.filter', $config['swagger']['ui']['filter']); + $container->setParameter('api_platform.swagger_ui.extra_configuration', $config['swagger']['ui_extra_configuration']); if (true === $config['openapi']['backward_compatibility_layer']) { $container->getDefinition('api_platform.swagger.normalizer.documentation')->addArgument($container->getDefinition('api_platform.openapi.normalizer')); diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php b/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php index 457569c9d65..eb493efcb46 100644 --- a/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php +++ b/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php @@ -339,19 +339,13 @@ private function addSwaggerSection(ArrayNodeDefinition $rootNode): void ->end() ->end() ->end() - ->arrayNode('ui') - ->addDefaultsIfNotSet() - ->children() - ->enumNode('doc_expansion') - ->info("Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).") - ->values(['list', 'full', 'none']) - ->defaultValue('list') - ->end() - ->booleanNode('filter') - ->info('If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown.') - ->defaultFalse() - ->end() + ->variableNode('ui_extra_configuration') + ->defaultValue([]) + ->validate() + ->ifTrue(static function ($v) { return false === \is_array($v); }) + ->thenInvalid('The ui_extra_configuration parameter must be an array.') ->end() + ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.') ->end() ->end() ->end() diff --git a/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml b/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml index e1121570675..f882312a68d 100644 --- a/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml +++ b/src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml @@ -38,8 +38,7 @@ %api_platform.swagger.versions% %api_platform.asset_package% - %api_platform.swagger_ui.doc_expansion% - %api_platform.swagger_ui.filter% + %api_platform.swagger_ui.extra_configuration% @@ -50,8 +49,7 @@ %api_platform.graphql.graphiql.enabled% %api_platform.graphql.graphql_playground.enabled% %api_platform.asset_package% - %api_platform.swagger_ui.doc_expansion% - %api_platform.swagger_ui.filter% + %api_platform.swagger_ui.extra_configuration% diff --git a/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js b/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js index 6ad77c6a95b..f248f92bbc2 100644 --- a/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js +++ b/src/Bridge/Symfony/Bundle/Resources/public/init-swagger-ui.js @@ -41,9 +41,7 @@ window.onload = function() { }).observe(document, {childList: true, subtree: true}); const data = JSON.parse(document.getElementById('swagger-data').innerText); - const ui = SwaggerUIBundle({ - docExpansion: data.docExpansion, - filter: data.filter, + const ui = SwaggerUIBundle(Object.assign({ spec: data.spec, dom_id: '#swagger-ui', validatorUrl: null, @@ -56,7 +54,7 @@ window.onload = function() { SwaggerUIBundle.plugins.DownloadUrl, ], layout: 'StandaloneLayout', - }); + }, data.extraConfiguration)); if (data.oauth.enabled) { ui.initOAuth({ diff --git a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php index 725f9c5ae6a..c88c89993e1 100644 --- a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php +++ b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php @@ -75,8 +75,6 @@ public function __invoke(Request $request) $swaggerData = [ 'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']), - 'docExpansion' => $this->swaggerUiContext->getDocExpansion(), - 'filter' => $this->swaggerUiContext->hasFilter(), 'spec' => $this->normalizer->normalize($openApi, 'json', []), 'oauth' => [ 'enabled' => $this->openApiOptions->getOAuthEnabled(), @@ -88,6 +86,7 @@ public function __invoke(Request $request) 'clientId' => $this->oauthClientId, 'clientSecret' => $this->oauthClientSecret, ], + 'extraConfiguration' => $this->swaggerUiContext->getExtraConfiguration(), ]; if ($request->isMethodSafe() && null !== $resourceClass = $request->attributes->get('_api_resource_class')) { diff --git a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php index 2a2a8f046ef..d37f51fcfbe 100644 --- a/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php +++ b/src/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiContext.php @@ -22,10 +22,9 @@ final class SwaggerUiContext private $graphiQlEnabled; private $graphQlPlaygroundEnabled; private $assetPackage; - private $docExpansion; - private $filter; + private $extraConfiguration; - public function __construct(bool $swaggerUiEnabled = false, bool $showWebby = true, bool $reDocEnabled = false, bool $graphQlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, $assetPackage = null, string $docExpansion = 'list', bool $filter = false) + public function __construct(bool $swaggerUiEnabled = false, bool $showWebby = true, bool $reDocEnabled = false, bool $graphQlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, $assetPackage = null, array $extraConfiguration = []) { $this->swaggerUiEnabled = $swaggerUiEnabled; $this->showWebby = $showWebby; @@ -34,11 +33,7 @@ public function __construct(bool $swaggerUiEnabled = false, bool $showWebby = tr $this->graphiQlEnabled = $graphiQlEnabled; $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled; $this->assetPackage = $assetPackage; - - if (\in_array($docExpansion, ['list', 'full', 'none'], true)) { - $this->docExpansion = $docExpansion; - } - $this->filter = $filter; + $this->extraConfiguration = $extraConfiguration; } public function isSwaggerUiEnabled(): bool @@ -76,13 +71,8 @@ public function getAssetPackage(): ?string return $this->assetPackage; } - public function getDocExpansion(): string - { - return $this->docExpansion; - } - - public function hasFilter(): bool + public function getExtraConfiguration(): array { - return $this->filter; + return $this->extraConfiguration; } } diff --git a/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php b/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php index 5d3a15060d3..ef9e674cc24 100644 --- a/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php +++ b/tests/Bridge/Symfony/Bundle/Action/SwaggerUiActionTest.php @@ -88,9 +88,8 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', - 'docExpansion' => 'list', - 'filter' => false, 'spec' => self::SPEC, + 'extraConfiguration' => [], 'oauth' => [ 'enabled' => false, 'clientId' => '', @@ -124,9 +123,8 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', - 'docExpansion' => 'list', - 'filter' => false, 'spec' => self::SPEC, + 'extraConfiguration' => [], 'oauth' => [ 'enabled' => false, 'clientId' => '', @@ -183,9 +181,8 @@ public function testDoNotRunCurrentRequest(Request $request) 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', - 'docExpansion' => 'list', - 'filter' => false, 'spec' => self::SPEC, + 'extraConfiguration' => [], 'oauth' => [ 'enabled' => false, 'clientId' => '', diff --git a/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php b/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php index 100f2c004bd..0b000383d13 100644 --- a/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php +++ b/tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php @@ -244,8 +244,7 @@ public function testSetNameConverter() $containerBuilderProphecy->hasParameter('kernel.debug')->willReturn(true); $containerBuilderProphecy->getParameter('kernel.debug')->willReturn(false); $containerBuilderProphecy->setAlias('api_platform.name_converter', $nameConverterId)->shouldBeCalled(); - $containerBuilderProphecy->setParameter('api_platform.swagger_ui.doc_expansion', 'list')->shouldBeCalled(); - $containerBuilderProphecy->setParameter('api_platform.swagger_ui.filter', false)->shouldBeCalled(); + $containerBuilderProphecy->setParameter('api_platform.swagger_ui.extra_configuration', [])->shouldBeCalled(); $containerBuilder = $containerBuilderProphecy->reveal(); @@ -1174,8 +1173,7 @@ private function getBaseContainerBuilderProphecy(array $doctrineIntegrationsToLo if ($hasSwagger) { $parameters['api_platform.swagger.versions'] = [2, 3]; $parameters['api_platform.swagger.api_keys'] = []; - $parameters['api_platform.swagger_ui.doc_expansion'] = 'list'; - $parameters['api_platform.swagger_ui.filter'] = false; + $parameters['api_platform.swagger_ui.extra_configuration'] = []; } else { $parameters['api_platform.swagger.versions'] = []; } diff --git a/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php b/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php index 3af0a9e26d3..06a8889ed50 100644 --- a/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php +++ b/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php @@ -150,10 +150,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm 'swagger' => [ 'versions' => [2, 3], 'api_keys' => [], - 'ui' => [ - 'doc_expansion' => 'list', - 'filter' => false, - ], + 'ui_extra_configuration' => [], ], 'eager_loading' => [ 'enabled' => true, diff --git a/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php b/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php index 523c2bcb41b..30f11ec638c 100644 --- a/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php +++ b/tests/Bridge/Symfony/Bundle/SwaggerUi/SwaggerUiActionTest.php @@ -88,8 +88,6 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', - 'docExpansion' => 'list', - 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, @@ -101,6 +99,7 @@ public function getInvokeParameters() 'authorizationUrl' => '', 'scopes' => [], ], + 'extraConfiguration' => [], 'shortName' => 'F', 'operationId' => 'getFCollection', 'id' => null, @@ -124,8 +123,6 @@ public function getInvokeParameters() 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', - 'docExpansion' => 'list', - 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, @@ -137,6 +134,7 @@ public function getInvokeParameters() 'authorizationUrl' => '', 'scopes' => [], ], + 'extraConfiguration' => [], 'shortName' => 'F', 'operationId' => 'getFItem', 'id' => null, @@ -178,8 +176,6 @@ public function testDoNotRunCurrentRequest(Request $request) 'assetPackage' => null, 'swagger_data' => [ 'url' => '/url', - 'docExpansion' => 'list', - 'filter' => false, 'spec' => self::SPEC, 'oauth' => [ 'enabled' => false, @@ -191,6 +187,7 @@ public function testDoNotRunCurrentRequest(Request $request) 'authorizationUrl' => '', 'scopes' => [], ], + 'extraConfiguration' => [], ], ])->shouldBeCalled()->willReturn(''); From 888e25c94234e6f0b2bd087403dd655195e5790a Mon Sep 17 00:00:00 2001 From: Alan Poulain Date: Tue, 23 Feb 2021 10:01:52 +0100 Subject: [PATCH 3/4] chore: add changelog entry --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f2ee9d43f2d..2102482d261 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,8 @@ * Doctrine: Better exception to find which resource is linked to an exception (#3965) * Doctrine: Allow mixed type value for date filter (notice if invalid) (#3870) * MongoDB: `date_immutable` support (#3940) -* Add `TraversablePaginator` (#3783) +* DataProvider: Add `TraversablePaginator` (#3783) +* Swagger UI: Add `ui_extra_configuration` to Swagger configuration (#3731) ## 2.6.3 From 288d0b297d6e4e94a931e87b170109bfe070addc Mon Sep 17 00:00:00 2001 From: Alan Poulain Date: Tue, 23 Feb 2021 10:21:00 +0100 Subject: [PATCH 4/4] feat: add swagger_ui_extra_configuration to OpenAPI configuration too --- CHANGELOG.md | 2 +- .../DependencyInjection/ApiPlatformExtension.php | 2 +- .../Bundle/DependencyInjection/Configuration.php | 12 ++++++++++-- .../Bundle/DependencyInjection/ConfigurationTest.php | 3 ++- 4 files changed, 14 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2102482d261..3486d0c7290 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ * Doctrine: Allow mixed type value for date filter (notice if invalid) (#3870) * MongoDB: `date_immutable` support (#3940) * DataProvider: Add `TraversablePaginator` (#3783) -* Swagger UI: Add `ui_extra_configuration` to Swagger configuration (#3731) +* Swagger UI: Add `swagger_ui_extra_configuration` to Swagger / OpenAPI configuration (#3731) ## 2.6.3 diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php b/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php index df63ed8b36f..8eee94a3990 100644 --- a/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php +++ b/src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php @@ -397,7 +397,7 @@ private function registerSwaggerConfiguration(ContainerBuilder $container, array $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']); - $container->setParameter('api_platform.swagger_ui.extra_configuration', $config['swagger']['ui_extra_configuration']); + $container->setParameter('api_platform.swagger_ui.extra_configuration', $config['openapi']['swagger_ui_extra_configuration'] ?? $config['swagger']['swagger_ui_extra_configuration']); if (true === $config['openapi']['backward_compatibility_layer']) { $container->getDefinition('api_platform.swagger.normalizer.documentation')->addArgument($container->getDefinition('api_platform.openapi.normalizer')); diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php b/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php index eb493efcb46..d14ec4533ab 100644 --- a/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php +++ b/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php @@ -339,11 +339,11 @@ private function addSwaggerSection(ArrayNodeDefinition $rootNode): void ->end() ->end() ->end() - ->variableNode('ui_extra_configuration') + ->variableNode('swagger_ui_extra_configuration') ->defaultValue([]) ->validate() ->ifTrue(static function ($v) { return false === \is_array($v); }) - ->thenInvalid('The ui_extra_configuration parameter must be an array.') + ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.') ->end() ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.') ->end() @@ -500,6 +500,14 @@ private function addOpenApiSection(ArrayNodeDefinition $rootNode): void ->scalarNode('url')->defaultNull()->info('URL to the license used for the API. MUST be in the format of a URL.')->end() ->end() ->end() + ->variableNode('swagger_ui_extra_configuration') + ->defaultValue([]) + ->validate() + ->ifTrue(static function ($v) { return false === \is_array($v); }) + ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.') + ->end() + ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.') + ->end() ->end() ->end() ->end(); diff --git a/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php b/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php index 06a8889ed50..4f544652f20 100644 --- a/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php +++ b/tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php @@ -150,7 +150,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm 'swagger' => [ 'versions' => [2, 3], 'api_keys' => [], - 'ui_extra_configuration' => [], + 'swagger_ui_extra_configuration' => [], ], 'eager_loading' => [ 'enabled' => true, @@ -220,6 +220,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm 'url' => null, ], 'backward_compatibility_layer' => true, + 'swagger_ui_extra_configuration' => [], ], ], $config); }