Ability to disable entrypoint and /api/docs

Author: Alexis Thinardon

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

@@ -143,6 +143,8 @@ public function load(array $configs, ContainerBuilder $container)
      */
     private function handleConfig(ContainerBuilder $container, array $config, array $formats, array $errorFormats)
     {
+        $container->setParameter('api_platform.enable_entrypoint', $config['enable_entrypoint']);
+        $container->setParameter('api_platform.enable_docs', $config['enable_docs']);
         $container->setParameter('api_platform.title', $config['title']);
         $container->setParameter('api_platform.description', $config['description']);
         $container->setParameter('api_platform.version', $config['version']);

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

@@ -99,6 +99,8 @@ public function getConfigTreeBuilder()
                 ->end()
                 ->booleanNode('enable_swagger')->defaultValue(true)->info('Enable the Swagger documentation and export.')->end()
                 ->booleanNode('enable_swagger_ui')->defaultValue(class_exists(TwigBundle::class))->info('Enable Swagger ui.')->end()
+                ->booleanNode('enable_entrypoint')->defaultTrue()->info('Enable the entrypoint')->end()
+                ->booleanNode('enable_docs')->defaultTrue()->info('Enable the docs')->end()
 
                 ->arrayNode('oauth')
                     ->canBeEnabled()

src/Bridge/Symfony/Bundle/Resources/config/api.xml

@@ -38,6 +38,8 @@
             <argument>%api_platform.resource_class_directories%</argument>
             <argument type="service" id="api_platform.subresource_operation_factory" />
             <argument>%api_platform.graphql.enabled%</argument>
+            <argument>%api_platform.enable_entrypoint%</argument>
+            <argument>%api_platform.enable_docs%</argument>
 
             <tag name="routing.loader" />
         </service>

src/Bridge/Symfony/Bundle/Resources/config/routing/api.xml

@@ -13,10 +13,4 @@
         <requirement key="index">index</requirement>
     </route>
 
-    <route id="api_doc" path="/docs.{_format}">
-        <default key="_controller">api_platform.action.documentation</default>
-        <default key="_api_respond">1</default>
-        <default key="_format" />
-    </route>
-
 </routes>

src/Bridge/Symfony/Bundle/Resources/config/routing/docs.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        http://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <route id="api_doc" path="/docs.{_format}">
+        <default key="_controller">api_platform.action.documentation</default>
+        <default key="_api_respond">1</default>
+        <default key="_format" />
+    </route>
+
+</routes>

src/Bridge/Symfony/Routing/ApiLoader.php

@@ -51,8 +51,10 @@ final class ApiLoader extends Loader
     private $resourceClassDirectories;
     private $subresourceOperationFactory;
     private $graphqlEnabled;
+    private $entrypointEnabled;
+    private $docsEnabled;
 
-    public function __construct(KernelInterface $kernel, ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, OperationPathResolverInterface $operationPathResolver, ContainerInterface $container, array $formats, array $resourceClassDirectories = [], SubresourceOperationFactoryInterface $subresourceOperationFactory = null, bool $graphqlEnabled = false)
+    public function __construct(KernelInterface $kernel, ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, OperationPathResolverInterface $operationPathResolver, ContainerInterface $container, array $formats, array $resourceClassDirectories = [], SubresourceOperationFactoryInterface $subresourceOperationFactory = null, bool $graphqlEnabled = false, bool $entrypointEnabled = true, bool $docsEnabled = true)
     {
         $this->fileLoader = new XmlFileLoader(new FileLocator($kernel->locateResource('@ApiPlatformBundle/Resources/config/routing')));
         $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
@@ -63,6 +65,8 @@ public function __construct(KernelInterface $kernel, ResourceNameCollectionFacto
         $this->resourceClassDirectories = $resourceClassDirectories;
         $this->subresourceOperationFactory = $subresourceOperationFactory;
         $this->graphqlEnabled = $graphqlEnabled;
+        $this->entrypointEnabled = $entrypointEnabled;
+        $this->docsEnabled = $docsEnabled;
     }
 
     /**
@@ -146,6 +150,14 @@ private function loadExternalFiles(RouteCollection $routeCollection)
     {
         $routeCollection->addCollection($this->fileLoader->load('api.xml'));
 
+        if ($this->entrypointEnabled) {
+            $routeCollection->addCollection($this->fileLoader->load('api.xml'));
+        }
+
+        if ($this->docsEnabled) {
+            $routeCollection->addCollection($this->fileLoader->load('docs.xml'));
+        }
+
         if ($this->graphqlEnabled) {
             $graphqlCollection = $this->fileLoader->load('graphql.xml');
             $graphqlCollection->addDefaults(['_graphql' => true]);

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

@@ -396,6 +396,8 @@ private function getPartialContainerBuilderProphecy($test = false)
             'api_platform.http_cache.shared_max_age' => null,
             'api_platform.http_cache.vary' => ['Accept'],
             'api_platform.http_cache.public' => null,
+            'api_platform.enable_entrypoint' => true,
+            'api_platform.enable_docs' => true,
         ];
 
         foreach ($parameters as $key => $value) {

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

@@ -78,6 +78,8 @@ public function testDefaultConfig()
             'enable_nelmio_api_doc' => false,
             'enable_swagger' => true,
             'enable_swagger_ui' => true,
+            'enable_entrypoint' => true,
+            'enable_docs' => true,
             'graphql' => [
                 'enabled' => true,
                 'graphiql' => [

tests/Bridge/Symfony/Routing/ApiLoaderTest.php

@@ -210,6 +210,8 @@ private function getApiLoaderWithResourceMetadata(ResourceMetadata $resourceMeta
             $containerProphecy->has($possibleArgument)->willReturn(true);
         }
         $containerProphecy->getParameter('api_platform.enable_swagger')->willReturn(true);
+        $containerProphecy->getParameter('api_platform.enable_entrypoint')->willReturn(true);
+        $containerProphecy->getParameter('api_platform.enable_docs')->willReturn(true);
 
         $containerProphecy->has(Argument::type('string'))->willReturn(false);
 
@@ -257,7 +259,7 @@ private function getApiLoaderWithResourceMetadata(ResourceMetadata $resourceMeta
 
         $subresourceOperationFactory = new SubresourceOperationFactory($resourceMetadataFactory, $propertyNameCollectionFactoryProphecy->reveal(), $propertyMetadataFactoryProphecy->reveal(), new UnderscorePathSegmentNameGenerator());
 
-        $apiLoader = new ApiLoader($kernelProphecy->reveal(), $resourceNameCollectionFactoryProphecy->reveal(), $resourceMetadataFactory, $operationPathResolver, $containerProphecy->reveal(), ['jsonld' => ['application/ld+json']], [], $subresourceOperationFactory, false);
+        $apiLoader = new ApiLoader($kernelProphecy->reveal(), $resourceNameCollectionFactoryProphecy->reveal(), $resourceMetadataFactory, $operationPathResolver, $containerProphecy->reveal(), ['jsonld' => ['application/ld+json']], [], $subresourceOperationFactory, false, true, true);
 
         return $apiLoader;
     }