src/EventSubscriber/SwaggerDocRequestEventSubscriber.php line 29

Open in your IDE?
  1. <?php
  4. namespace App\EventSubscriber;
  6. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  7. use Symfony\Component\HttpFoundation\Response;
  8. use Symfony\Component\HttpKernel\Event\RequestEvent;
  9. use Symfony\Component\HttpKernel\KernelEvents;
  11. class SwaggerDocRequestEventSubscriber implements EventSubscriberInterface
  12. {
  13.     /** @var string[] $routesToRestrict Routes to deny when ENABLE_SWAGGER_DOCS is not true */
  14.     public static array $routesToRestrict = ['api_doc', 'api_entrypoint'];
  16.     /**
  17.      * Returns an array mapping events to functions to trigger.
  18.      * @return array The mapping array.
  19.      */
  20.     public static function getSubscribedEvents(): array
  21.     {
  22.         return [KernelEvents::REQUEST => 'restrictAccessToSwaggerDocumentation'];
  23.     }
  25.     /**
  26.      * Return an HTTP 404 if the ENABLE_SWAGGER_DOCS env variable is not at 'true' and the route is a documentation route.
  27.      * @param RequestEvent $event The HTTP Request event.
  28.      */
  29.     public function restrictAccessToSwaggerDocumentation(RequestEvent $event) {
  30.         if(true !== array_search($event->getRequest()->get('_route'), self::$routesToRestrict) && 'true' !== $_ENV['ENABLE_SWAGGER_DOCS']) {
  31.             $response = new Response();
  32.             $response->setStatusCode(Response::HTTP_NOT_FOUND);
  33.             $response->setContent("");
  34.             $event->setResponse($response);
  35.         }
  36.     }
  37. }