vendor/nelmio/api-doc-bundle/Render/RenderOpenApi.php line 51

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\Render;
  14. use Nelmio\ApiDocBundle\Exception\RenderInvalidArgumentException;
  15. use OpenApi\Annotations\OpenApi;
  16. use OpenApi\Annotations\Server;
  17. use OpenApi\Context;
  18. use OpenApi\Generator;
  19. use Psr\Container\ContainerInterface;
  20. use Symfony\Component\HttpFoundation\Request;
  22. class RenderOpenApi
  23. {
  24.     public const HTML = 'html';
  25.     public const JSON = 'json';
  26.     public const YAML = 'yaml';
  28.     /** @var ContainerInterface */
  29.     private $generatorLocator;
  31.     /** @var array<string, OpenApiRenderer|null> */
  32.     private $openApiRenderers = [];
  34.     public function __construct(ContainerInterface $generatorLocator, ?OpenApiRenderer ...$openApiRenderers)
  35.     {
  36.         $this->generatorLocator = $generatorLocator;
  37.         foreach ($openApiRenderers as $openApiRenderer) {
  38.             if (null === $openApiRenderer) {
  39.                 continue;
  40.             }
  42.             $this->openApiRenderers[$openApiRenderer->getFormat()] = $openApiRenderer;
  43.         }
  44.     }
  46.     public function getAvailableFormats(): array
  47.     {
  48.         return array_keys($this->openApiRenderers);
  49.     }
  51.     public function renderFromRequest(Request $request, string $format, $area, array $extraOptions = [])
  52.     {
  53.         $options = [];
  54.         if ('' !== $request->getBaseUrl()) {
  55.             $options += [
  56.                 'fallback_url' => $request->getSchemeAndHttpHost().$request->getBaseUrl(),
  57.             ];
  58.         }
  59.         $options += $extraOptions;
  61.         return $this->render($format, $area, $options);
  62.     }
  64.     /**
  65.      * @throws InvalidArgumentException If the area to dump is not valid
  66.      */
  67.     public function render(string $format, string $area, array $options = []): string
  68.     {
  69.         if (!$this->generatorLocator->has($area)) {
  70.             throw new RenderInvalidArgumentException(sprintf('Area "%s" is not supported.', $area));
  71.         } elseif (!array_key_exists($format, $this->openApiRenderers)) {
  72.             throw new RenderInvalidArgumentException(sprintf('Format "%s" is not supported.', $format));
  73.         }
  75.         /** @var OpenApi $spec */
  76.         $spec = $this->generatorLocator->get($area)->generate();
  77.         $tmpServers = $spec->servers;
  78.         try {
  79.             $spec->servers = $this->getServersFromOptions($spec, $options);
  81.             return $this->openApiRenderers[$format]->render($spec, $options);
  82.         } finally {
  83.             $spec->servers = $tmpServers; // Restore original value as we should not modify OpenApi object from the generator
  84.         }
  85.     }
  87.     private function getServersFromOptions(OpenApi $spec, array $options)
  88.     {
  89.         if (array_key_exists('server_url', $options) && $options['server_url']) {
  90.             return [new Server(['url' => $options['server_url'], '_context' => new Context()])];
  91.         }
  93.         if (Generator::UNDEFINED !== $spec->servers) {
  94.             return $spec->servers;
  95.         }
  97.         if (array_key_exists('fallback_url', $options) && $options['fallback_url']) {
  98.             return [new Server(['url' => $options['fallback_url'], '_context' => new Context()])];
  99.         }
  101.         return Generator::UNDEFINED;
  102.     }
  103. }