vendor/nelmio/api-doc-bundle/Controller/SwaggerUiController.php line 22

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the NelmioApiDocBundle package.
  5.  *
  6.  * (c) Nelmio
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Nelmio\ApiDocBundle\Controller;
  14. use Nelmio\ApiDocBundle\ApiDocGenerator;
  15. use Psr\Container\ContainerInterface;
  16. use Symfony\Component\DependencyInjection\ServiceLocator;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  20. use Twig\Environment;
  22. final class SwaggerUiController
  23. {
  24.     private $generatorLocator;
  26.     private $twig;
  28.     /**
  29.      * @param ContainerInterface $generatorLocator
  30.      */
  31.     public function __construct($generatorLocator, $twig)
  32.     {
  33.         if (!$twig instanceof \Twig_Environment && !$twig instanceof Environment) {
  34.             throw new \InvalidArgumentException(sprintf('Providing an instance of "%s" as twig is not supported.', get_class($twig)));
  35.         }
  37.         if (!$generatorLocator instanceof ContainerInterface) {
  38.             if (!$generatorLocator instanceof ApiDocGenerator) {
  39.                 throw new \InvalidArgumentException(sprintf('Providing an instance of "%s" to "%s" is not supported.', get_class($generatorLocator), __METHOD__));
  40.             }
  42.             @trigger_error(sprintf('Providing an instance of "%s" to "%s()" is deprecated since version 3.1. Provide it an instance of "%s" instead.', ApiDocGenerator::class, __METHOD__, ContainerInterface::class), E_USER_DEPRECATED);
  43.             $generatorLocator = new ServiceLocator(['default' => function () use ($generatorLocator): ApiDocGenerator {
  44.                 return $generatorLocator;
  45.             }]);
  46.         }
  48.         $this->generatorLocator = $generatorLocator;
  49.         $this->twig = $twig;
  50.     }
  52.     public function __invoke(Request $request, $area = 'default')
  53.     {
  54.         if (!$this->generatorLocator->has($area)) {
  55.             $advice = '';
  56.             if (false !== strpos($area, '.json')) {
  57.                 $advice = ' Since the area provided contains `.json`, the issue is likely caused by route priorities. Try switching the Swagger UI / the json documentation routes order.';
  58.             }
  60.             throw new BadRequestHttpException(sprintf('Area "%s" is not supported as it isn\'t defined in config.%s', $area, $advice));
  61.         }
  63.         $spec = $this->generatorLocator->get($area)->generate()->toArray();
  64.         if ('' !== $request->getBaseUrl()) {
  65.             $spec['basePath'] = $request->getBaseUrl();
  66.         }
  68.         $response = new Response(
  69.             $this->twig->render('@NelmioApiDoc/SwaggerUi/index.html.twig', ['swagger_data' => ['spec' => $spec]]),
  70.             Response::HTTP_OK,
  71.             ['Content-Type' => 'text/html']
  72.         );
  74.         return $response->setCharset('UTF-8');
  75.     }
  76. }