Add `swagger_ui_extra_configuration` to Swagger configuration #3731

dvc · 2020-09-21T12:26:47Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tickets	fixes #3730
License	MIT
Doc PR	api-platform/docs/pull/1168

dvc · 2020-09-22T09:41:19Z

Code quality breaks in other files: https://insight.symfony.com/projects/92d78899-946c-4282-89a3-ac92344f9a93/analyses/6895

Do i need to fix it? And how? :)

soyuka · 2020-09-29T14:14:57Z

Nice work, as it's a new feature could you target the master branch please?

I'll add some comments. Don't worry about the symfony insight.

soyuka · 2020-09-29T14:17:31Z

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

@@ -300,6 +300,20 @@ private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
                                ->end()
                            ->end()
                        ->end()
+                        ->arrayNode('display')


What do you think about using ui instead of display?

swagger: ui: doc_expansion: 'full'

soyuka · 2020-09-29T14:18:12Z

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

@@ -344,6 +344,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.doc_expansion', $config['swagger']['display']['doc_expansion']);


Suggested change

$container->setParameter('api_platform.swagger.doc_expansion', $config['swagger']['display']['doc_expansion']);

$container->setParameter('api_platform.swagger_ui.doc_expansion', $config['swagger']['display']['doc_expansion']);

soyuka · 2020-09-29T14:18:23Z

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

@@ -344,6 +344,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.doc_expansion', $config['swagger']['display']['doc_expansion']);
+        $container->setParameter('api_platform.swagger.filter', $config['swagger']['display']['filter']);


Suggested change

$container->setParameter('api_platform.swagger.filter', $config['swagger']['display']['filter']);

$container->setParameter('api_platform.swagger_ui.filter', $config['swagger']['display']['filter']);

dvc · 2020-09-30T09:28:24Z

@soyuka , thank you for review. I've fix it.

ApiPlatform\Core\Bridge\Symfony\Bundle\Action\SwaggerUiAction is deprecated in master.

dvc · 2020-12-12T12:22:46Z

@soyuka , hello!

I've update this PR. Can you review it?

dunglas · 2020-09-21T17:23:33Z

src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php

@@ -139,6 +151,8 @@ private function getContext(Request $request, Documentation $documentation): arr

        $swaggerData = [
            'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
+            'docExpansion' => $this->swaggerDocExpansion,


Shouldn't we just add an extra_config key or something like this allowing to pass a variable map to Swagger UI. So we'll support all possible options and we will be future-proof.

I'm not shure.
There are some already used config values. Merging testing required.
What about config validation? Is it user's responsibility? Should any options to be blacklisted for any reason?

alanpoulain · 2021-02-19T17:03:33Z

Now uses a ui_extra_configuration key, like @dunglas asked.
Tested on the demo, with:

api_platform:
    swagger:
        versions: [3, 2]
        api_keys:
            apiKey:
                name: Authorization
                type: header
        swagger_ui_extra_configuration:
            filter: true
            docExpansion: none

It shows:

alanpoulain · 2021-02-23T09:34:47Z

Thank you @dvc!

…atform#3731) (cherry picked from commit 930c930)

dvc marked this pull request as ready for review September 22, 2020 09:34

soyuka reviewed Sep 29, 2020

View reviewed changes

dvc changed the base branch from 2.5 to master September 30, 2020 08:48

soyuka added the [WIP] Work In Progress label Nov 8, 2020

dunglas requested changes Jan 20, 2021

View reviewed changes

Base automatically changed from master to main January 23, 2021 21:59

alanpoulain added 2 commits February 19, 2021 17:04

Add doc_expansion and filter to swagger config

dc2db3a

Use ui_extra_configuration

a0b9149

alanpoulain force-pushed the swagger_ui_config_patch branch from 8147cfb to a0b9149 Compare February 19, 2021 16:37

alanpoulain changed the title ~~WIP: add docExpansion and filter to swagger.display config~~ Add ui_extra_configuration to Swagger configuration Feb 19, 2021

alanpoulain removed the [WIP] Work In Progress label Feb 19, 2021

alanpoulain requested review from dunglas and soyuka February 19, 2021 17:03

alanpoulain added 2 commits February 23, 2021 10:01

chore: add changelog entry

888e25c

feat: add swagger_ui_extra_configuration to OpenAPI configuration too

288d0b2

alanpoulain changed the title ~~Add ui_extra_configuration to Swagger configuration~~ Add swagger_ui_extra_configuration to Swagger configuration Feb 23, 2021

alanpoulain merged commit 930c930 into api-platform:main Feb 23, 2021

camohob pushed a commit to camohob/core that referenced this pull request Mar 25, 2021

Add swagger_ui_extra_configuration to Swagger configuration (api-pl…

a088027

…atform#3731) (cherry picked from commit 930c930)

camohob pushed a commit to camohob/core that referenced this pull request Mar 25, 2021

Add swagger_ui_extra_configuration to Swagger configuration (api-pl…

e44cd9e

…atform#3731) (cherry picked from commit 930c930)

camohob added a commit to camohob/core that referenced this pull request Mar 25, 2021

Add swagger_ui_extra_configuration to Swagger configuration (api-pl…

a119a37

…atform#3731) (cherry picked from commit 930c930)

camohob pushed a commit to camohob/core that referenced this pull request Mar 25, 2021

Add swagger_ui_extra_configuration to Swagger configuration (api-pl…

b0a2e97

…atform#3731) (cherry picked from commit 930c930)

camohob pushed a commit to camohob/core that referenced this pull request Apr 7, 2021

Add swagger_ui_extra_configuration to Swagger configuration (api-pl…

6c93abd

…atform#3731) (cherry picked from commit 930c930)

camohob added a commit to camohob/core that referenced this pull request Apr 7, 2021

Add swagger_ui_extra_configuration to Swagger configuration (api-pl…

7db311e

…atform#3731) (cherry picked from commit 930c930)

alanpoulain mentioned this pull request Oct 1, 2021

Is possible to pass more parameters to Redoc for more customization (introduction, sub-menu, etc ) ? #4484

Closed

alanpoulain mentioned this pull request Aug 17, 2022

Symfony - Hide the "Schemas" section api-platform/api-platform#2233

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `swagger_ui_extra_configuration` to Swagger configuration #3731

Add `swagger_ui_extra_configuration` to Swagger configuration #3731

dvc commented Sep 21, 2020 •

edited

Loading

dvc commented Sep 22, 2020

soyuka commented Sep 29, 2020

soyuka Sep 29, 2020

soyuka Sep 29, 2020

soyuka Sep 29, 2020

dvc commented Sep 30, 2020

dvc commented Dec 12, 2020

dunglas Sep 21, 2020

dvc Jan 20, 2021

alanpoulain commented Feb 19, 2021 •

edited

Loading

alanpoulain commented Feb 23, 2021

	$container->setParameter('api_platform.swagger.doc_expansion', $config['swagger']['display']['doc_expansion']);
	$container->setParameter('api_platform.swagger_ui.doc_expansion', $config['swagger']['display']['doc_expansion']);

Add swagger_ui_extra_configuration to Swagger configuration #3731

Add swagger_ui_extra_configuration to Swagger configuration #3731

Conversation

dvc commented Sep 21, 2020 • edited Loading

dvc commented Sep 22, 2020

soyuka commented Sep 29, 2020

soyuka Sep 29, 2020

Choose a reason for hiding this comment

soyuka Sep 29, 2020

Choose a reason for hiding this comment

soyuka Sep 29, 2020

Choose a reason for hiding this comment

dvc commented Sep 30, 2020

dvc commented Dec 12, 2020

dunglas Sep 21, 2020

Choose a reason for hiding this comment

dvc Jan 20, 2021

Choose a reason for hiding this comment

alanpoulain commented Feb 19, 2021 • edited Loading

alanpoulain commented Feb 23, 2021

Add `swagger_ui_extra_configuration` to Swagger configuration #3731

Add `swagger_ui_extra_configuration` to Swagger configuration #3731

dvc commented Sep 21, 2020 •

edited

Loading

alanpoulain commented Feb 19, 2021 •

edited

Loading