feat(openapi): HTTP Authentication Support for Swagger UI (#6665)

* feat(openapi): http authentication support

add support for http authentication (for example http basic or bearer tokens)

Closes: #6664

* add symfony support

---------

Co-authored-by: soyuka <[email protected]>

Author: toitzi

Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -500,6 +500,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.http_auth', $config['swagger']['http_auth']);
         if ($config['openapi']['swagger_ui_extra_configuration'] && $config['swagger']['swagger_ui_extra_configuration']) {
             throw new RuntimeException('You can not set "swagger_ui_extra_configuration" twice - in "openapi" and "swagger" section.');
         }

Bundle/DependencyInjection/Configuration.php

@@ -330,6 +330,24 @@ private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('http_auth')
+                            ->info('Creates http security schemes for OpenAPI.')
+                            ->useAttributeAsKey('key')
+                            ->validate()
+                                ->ifTrue(static fn ($v): bool => (bool) array_filter(array_keys($v), fn ($item) => !preg_match('/^[a-zA-Z0-9._-]+$/', $item)))
+                                ->thenInvalid('The api keys "key" is not valid according to the pattern enforced by OpenAPI 3.1 ^[a-zA-Z0-9._-]+$.')
+                            ->end()
+                            ->prototype('array')
+                                ->children()
+                                    ->scalarNode('scheme')
+                                        ->info('The OpenAPI HTTP auth scheme, for example "bearer"')
+                                    ->end()
+                                    ->scalarNode('bearerFormat')
+                                        ->info('The OpenAPI HTTP bearer format')
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
                         ->variableNode('swagger_ui_extra_configuration')
                             ->defaultValue([])
                             ->validate()

Bundle/Resources/config/openapi.xml

@@ -59,6 +59,7 @@
             <argument>%api_platform.openapi.license.name%</argument>
             <argument>%api_platform.openapi.license.url%</argument>
             <argument>%api_platform.openapi.overrideResponses%</argument>
+            <argument>%api_platform.swagger.http_auth%</argument>
         </service>
         <service id="ApiPlatform\OpenApi\Options" alias="api_platform.openapi.options" />
 

Tests/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -284,5 +284,6 @@ public function testEventListenersConfiguration(): void
         ];
 
         $this->assertContainerHas($services, $aliases);
+        $this->container->hasParameter('api_platform.swagger.http_auth');
     }
 }