jimmyMorizot
commented
4 months ago I found the solution to exclude the forgot-password routes from the ReDoc documentation.
To make it work, it was necessary to create a separate ForgotPasswordOpenApiFactory apart from the CustomOpenApiFactory.
Here's how I did it:
Custom ForgotPasswordOpenApiFactory: I created a custom ForgotPasswordOpenApiFactory class that extends AbstractOpenApiFactory and implements OpenApiFactoryInterface. This class filters out the forgot-password paths.
namespace App\OpenApi;
use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\OpenApi\Model\Paths;
use ApiPlatform\OpenApi\OpenApi;
use CoopTilleuls\ForgotPasswordBundle\Bridge\ApiPlatform\OpenApi\AbstractOpenApiFactory;
use CoopTilleuls\ForgotPasswordBundle\Provider\ProviderChainInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\RouterInterface;
class ForgotPasswordOpenApiFactory extends AbstractOpenApiFactory implements OpenApiFactoryInterface
{
public function __construct(OpenApiFactoryInterface $decorated, RouterInterface $router, ProviderChainInterface $providerChain, private RequestStack $requestStack)
{
parent::__construct($decorated, $router, $providerChain);
}
public function __invoke(array $context = []): OpenApi
{
$openApi = parent::__invoke($context);
$request = $this->requestStack->getCurrentRequest();
if ($request && $request->query->get('ui') === 're_doc') {
$filteredPaths = new Paths();
foreach ($openApi->getPaths()->getPaths() as $path => $pathItem) {
if (!preg_match('#^/api/forgot-password#', $path)) {
$filteredPaths->addPath($path, $pathItem);
}
}
return $openApi->withPaths($filteredPaths);
}
return $openApi;
}
}Service Configuration: I configured the service in services.yaml:
App\OpenApi\ForgotPasswordOpenApiFactory:
decorates: 'coop_tilleuls_forgot_password.openapi.factory'
arguments: ['@App\OpenApi\ForgotPasswordOpenApiFactory.inner', '@router', '@coop_tilleuls_forgot_password.provider_chain', '@request_stack']By creating a separate ForgotPasswordOpenApiFactory, I was able to successfully exclude the forgot-password routes from the ReDoc documentation.
vincentchalamon
Hello,
I am currently using the CoopTilleulsForgotPasswordBundle in my Symfony project alongside API Platform for generating OpenAPI documentation. I have a specific need to exclude the forgot-password routes from the documentation when using ReDoc, but keep them in the Swagger UI documentation.
Here is the context:
Swagger UI Documentation:
I need to include the documentation for all my exposed entities so my colleague, who is developing the frontend, can see and use this documentation. ReDoc Documentation:
I need to include only specific entities as this documentation will be used for web services that connect their applications to mine. In this documentation, I am struggling to exclude the forgot-password routes. Here is my current CustomOpenApiFactory implementation:
Despite this setup, the forgot-password routes still appear in the ReDoc documentation. Here are the routes I would like to exclude specifically:
/api/forgot-password /api/forgot-password/{tokenValue} /api/forgot-password/{tokenValue}/reset I have verified that the routes are correctly defined and that the paths are being processed. However, they are not being excluded as expected.
Is there a recommended way to specifically disable or exclude these routes from appearing in the ReDoc documentation only, while keeping them available for other API documentation tools like Swagger UI?
Thank you in advance for your assistance.