vendor/api-platform/core/src/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php line 62

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Symfony\Bundle\SwaggerUi;
  16. use ApiPlatform\Exception\RuntimeException;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  18. use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
  19. use ApiPlatform\OpenApi\Options;
  20. use ApiPlatform\OpenApi\Serializer\NormalizeOperationNameTrait;
  21. use Symfony\Component\HttpFoundation\Request;
  22. use Symfony\Component\HttpFoundation\Response;
  23. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  24. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  25. use Twig\Environment as TwigEnvironment;
  27. /**
  28.  * Displays the swaggerui interface.
  29.  *
  30.  * @author Antoine Bluchet <soyuka@gmail.com>
  31.  */
  32. final class SwaggerUiAction
  33. {
  34.     use NormalizeOperationNameTrait;
  36.     public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly ?TwigEnvironment $twig, private readonly UrlGeneratorInterface $urlGenerator, private readonly NormalizerInterface $normalizer, private readonly OpenApiFactoryInterface $openApiFactory, private readonly Options $openApiOptions, private readonly SwaggerUiContext $swaggerUiContext, private readonly array $formats = [], private readonly ?string $oauthClientId = null, private readonly ?string $oauthClientSecret = null, private readonly bool $oauthPkce = false)
  37.     {
  38.         if (null === $this->twig) {
  39.             throw new \RuntimeException('The documentation cannot be displayed since the Twig bundle is not installed. Try running "composer require symfony/twig-bundle".');
  40.         }
  41.     }
  43.     public function __invoke(Request $request): Response
  44.     {
  45.         $openApi = $this->openApiFactory->__invoke(['base_url' => $request->getBaseUrl() ?: '/']);
  47.         $swaggerContext = [
  48.             'formats' => $this->formats,
  49.             'title' => $openApi->getInfo()->getTitle(),
  50.             'description' => $openApi->getInfo()->getDescription(),
  51.             'showWebby' => $this->swaggerUiContext->isWebbyShown(),
  52.             'swaggerUiEnabled' => $this->swaggerUiContext->isSwaggerUiEnabled(),
  53.             'reDocEnabled' => $this->swaggerUiContext->isRedocEnabled(),
  54.             'graphQlEnabled' => $this->swaggerUiContext->isGraphQlEnabled(),
  55.             'graphiQlEnabled' => $this->swaggerUiContext->isGraphiQlEnabled(),
  56.             'graphQlPlaygroundEnabled' => $this->swaggerUiContext->isGraphQlPlaygroundEnabled(),
  57.             'assetPackage' => $this->swaggerUiContext->getAssetPackage(),
  58.         ];
  60.         $swaggerData = [
  61.             'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
  62.             'spec' => $this->normalizer->normalize($openApi, 'json', []),
  63.             'oauth' => [
  64.                 'enabled' => $this->openApiOptions->getOAuthEnabled(),
  65.                 'type' => $this->openApiOptions->getOAuthType(),
  66.                 'flow' => $this->openApiOptions->getOAuthFlow(),
  67.                 'tokenUrl' => $this->openApiOptions->getOAuthTokenUrl(),
  68.                 'authorizationUrl' => $this->openApiOptions->getOAuthAuthorizationUrl(),
  69.                 'scopes' => $this->openApiOptions->getOAuthScopes(),
  70.                 'clientId' => $this->oauthClientId,
  71.                 'clientSecret' => $this->oauthClientSecret,
  72.                 'pkce' => $this->oauthPkce,
  73.             ],
  74.             'extraConfiguration' => $this->swaggerUiContext->getExtraConfiguration(),
  75.         ];
  77.         if ($request->isMethodSafe() && null !== $resourceClass = $request->attributes->get('_api_resource_class')) {
  78.             $swaggerData['id'] = $request->attributes->get('id');
  79.             $swaggerData['queryParameters'] = $request->query->all();
  81.             $metadata = $this->resourceMetadataFactory->create($resourceClass)->getOperation($request->attributes->get('_api_operation_name'));
  83.             $swaggerData['shortName'] = $metadata->getShortName();
  84.             $swaggerData['operationId'] = $this->normalizeOperationName($metadata->getName());
  86.             [$swaggerData['path'], $swaggerData['method']] = $this->getPathAndMethod($swaggerData);
  87.         }
  89.         return new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $swaggerContext + ['swagger_data' => $swaggerData]));
  90.     }
  92.     private function getPathAndMethod(array $swaggerData): array
  93.     {
  94.         foreach ($swaggerData['spec']['paths'] as $path => $operations) {
  95.             foreach ($operations as $method => $operation) {
  96.                 if (($operation['operationId'] ?? null) === $swaggerData['operationId']) {
  97.                     return [$path, $method];
  98.                 }
  99.             }
  100.         }
  102.         throw new RuntimeException(sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));
  103.     }
  104. }