Skip to content

fix(symfony): make enable_docs a master switch for disabling documentation #7806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
soyuka wants to merge 1 commit into
base: 4.2
Choose a base branch
from
+27 −2
Open

fix(symfony): make enable_docs a master switch for disabling documentation #7806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ public function load(array $configs, ContainerBuilder $container): void
if (!isset($config['defaults']['hideHydraOperation']) && !isset($config['defaults']['hide_hydra_operation'])) {
$config['defaults']['hideHydraOperation'] = true;
}
// Disabling docs is a master switch: also disable Swagger UI and ReDoc
// to prevent HTML documentation from being served on resource endpoints.
$config['enable_swagger_ui'] = false;
$config['enable_re_doc'] = false;
}
$jsonSchemaFormats = $config['jsonschema_formats'];

Expand Down
25 changes: 23 additions & 2 deletions tests/Functional/DocumentationActionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,18 @@ class DocumentationActionAppKernel extends \AppKernel
{
public static bool $swaggerUiEnabled = true;
public static bool $reDocEnabled = true;
public static bool $docsEnabled = true;

public function getCacheDir(): string
{
$suffix = (self::$swaggerUiEnabled ? 'ui_' : 'no_ui_').(self::$reDocEnabled ? 'redoc' : 'no_redoc');
$suffix = (self::$swaggerUiEnabled ? 'ui_' : 'no_ui_').(self::$reDocEnabled ? 'redoc' : 'no_redoc').(self::$docsEnabled ? '' : '_no_docs');

return parent::getCacheDir().'/'.$suffix;
}

public function getLogDir(): string
{
$suffix = (self::$swaggerUiEnabled ? 'ui_' : 'no_ui_').(self::$reDocEnabled ? 'redoc' : 'no_redoc');
$suffix = (self::$swaggerUiEnabled ? 'ui_' : 'no_ui_').(self::$reDocEnabled ? 'redoc' : 'no_redoc').(self::$docsEnabled ? '' : '_no_docs');

return parent::getLogDir().'/'.$suffix;
}
Expand All @@ -47,6 +48,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
$container->loadFromExtension('api_platform', [
'enable_swagger_ui' => DocumentationActionAppKernel::$swaggerUiEnabled,
'enable_re_doc' => DocumentationActionAppKernel::$reDocEnabled,
'enable_docs' => DocumentationActionAppKernel::$docsEnabled,
]);
});
}
Expand Down Expand Up @@ -158,4 +160,23 @@ public function testJsonDocumentationIsAccessibleWhenSwaggerUiIsEnabled(): void
$this->assertJsonContains(['openapi' => '3.1.0']);
$this->assertJsonContains(['info' => ['title' => 'My Dummy API']]);
}

public function testEnableDocsFalseDisablesSwaggerUiAndReDoc(): void
{
DocumentationActionAppKernel::$swaggerUiEnabled = true;
DocumentationActionAppKernel::$reDocEnabled = true;
DocumentationActionAppKernel::$docsEnabled = false;

$client = self::createClient();

$container = static::getContainer();
$this->assertFalse($container->getParameter('api_platform.enable_docs'));
// enable_docs: false acts as a master switch, forcing these to false
$this->assertFalse($container->getParameter('api_platform.enable_swagger_ui'));
$this->assertFalse($container->getParameter('api_platform.enable_re_doc'));

$client->request('GET', '/docs', ['headers' => ['Accept' => 'text/html']]);
$this->assertResponseStatusCodeSame(404);
}

}
Loading