-refactoring

Author: alexndlm

behat.yml.dist

@@ -18,7 +18,7 @@ default:
         tags: '~@postgres&&~@mongodb&&~@elasticsearch&&~@controller&&~@mercure&&~@query_parameter_validator'
   extensions:
     'FriendsOfBehat\SymfonyExtension':
-      bootstrap: 'tests/Fixtures/app/bootstrap.php'
+      bootstrap: '/Users/alex/PhpstormProjects/api-platform-core/tests/Fixtures/app/bootstrap.php'
       kernel:
         environment: 'test'
         debug: true
@@ -203,7 +203,7 @@ legacy:
         environment: 'test'
         debug: true
         class: AppKernel
-        path: 'tests/Fixtures/app/AppKernel.php'
+        path: '/Users/alex/PhpstormProjects/api-platform-core/tests/Fixtures/app/AppKernel.php'
     'Behat\MinkExtension':
       base_url: 'http://example.com/'
       files_path: 'features/files'
@@ -232,12 +232,12 @@ symfony_listeners:
         tags: '~@postgres&&~@mongodb&&~@elasticsearch&&~@mercure&&~@query_parameter_validator'
   extensions:
     'FriendsOfBehat\SymfonyExtension':
-      bootstrap: 'tests/Fixtures/app/bootstrap.php'
+      bootstrap: '/Users/alex/PhpstormProjects/api-platform-core/tests/Fixtures/app/bootstrap.php'
       kernel:
         environment: 'test'
         debug: true
         class: AppKernel
-        path: 'tests/Fixtures/app/AppKernel.php'
+        path: '/Users/alex/PhpstormProjects/api-platform-core/tests/Fixtures/app/AppKernel.php'
     'Behat\MinkExtension':
       base_url: 'http://example.com/'
       files_path: 'features/files'

src/Symfony/Action/DocumentationAction.php

@@ -50,6 +50,7 @@ public function __construct(
         ?Negotiator $negotiator = null,
         private readonly array $documentationFormats = [OpenApiNormalizer::JSON_FORMAT => ['application/vnd.openapi+json'], OpenApiNormalizer::FORMAT => ['application/json']],
         private readonly bool $swaggerUiEnabled = true,
+        private readonly bool $docsEnabled = true,
     ) {
         $this->negotiator = $negotiator ?? new Negotiator();
     }
@@ -59,6 +60,10 @@ public function __construct(
      */
     public function __invoke(?Request $request = null)
     {
+        if ($this->docsEnabled === false) {
+            throw new NotFoundHttpException('API documentation is disabled.');
+        }
+
         if (null === $request) {
             return new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version);
         }

src/Symfony/Bundle/Resources/config/symfony/controller.php

@@ -48,5 +48,6 @@
             service('api_platform.negotiator')->nullOnInvalid(),
             '%api_platform.docs_formats%',
             '%api_platform.enable_swagger_ui%',
+            '%api_platform.enable_docs%',
         ]);
 };

src/Symfony/Bundle/Resources/config/symfony/events.php

@@ -180,6 +180,7 @@
             service('api_platform.negotiator')->nullOnInvalid(),
             '%api_platform.docs_formats%',
             '%api_platform.enable_swagger_ui%',
+            '%api_platform.enable_docs%',
         ]);
 
     $services->set('api_platform.action.placeholder', 'ApiPlatform\Symfony\Action\PlaceholderAction')

src/Symfony/Routing/ApiLoader.php

@@ -127,10 +127,7 @@ public function supports(mixed $resource, ?string $type = null): bool
      */
     private function loadExternalFiles(RouteCollection $routeCollection): void
     {
-        if ($this->docsEnabled || isset($this->formats['jsonld'])) {
-            $routeCollection->addCollection($this->fileLoader->load('docs.php'));
-        }
-
+        $routeCollection->addCollection($this->fileLoader->load('docs.php'));
         $routeCollection->addCollection($this->fileLoader->load('genid.php'));
         $routeCollection->addCollection($this->fileLoader->load('errors.php'));
 

src/Symfony/Tests/Action/DocumentationActionTest.php

@@ -154,4 +154,27 @@ public function testHtmlFormatNotSupportedThrowsException(): void
 
         $documentation($request);
     }
+
+    public function testHtmlFormatWhenDocsDisabledThrows404(): void
+    {
+        $this->expectException(NotFoundHttpException::class);
+        $this->expectExceptionMessage('API documentation is disabled.');
+
+        $request = new Request();
+        $request->attributes->set('_format', 'html');
+
+        $openApiFactory = $this->createMock(OpenApiFactoryInterface::class);
+        $resourceNameCollectionFactory = $this->createMock(ResourceNameCollectionFactoryInterface::class);
+
+        $documentation = new DocumentationAction(
+            $resourceNameCollectionFactory,
+            openApiFactory: $openApiFactory,
+            documentationFormats: [
+                'html' => ['text/html'],
+            ],
+            docsEnabled: false,
+        );
+
+        $documentation($request);
+    }
 }