vendor/api-platform/core/src/Core/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php line 38

Open in your IDE?
  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\Core\Bridge\Symfony\Bundle\Action;
  16. use ApiPlatform\Core\Api\FormatsProviderInterface;
  17. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  18. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  19. use ApiPlatform\Documentation\Documentation;
  20. use ApiPlatform\Exception\RuntimeException;
  21. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  22. use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  23. use ApiPlatform\Symfony\Bundle\SwaggerUi\SwaggerUiAction as OpenApiSwaggerUiAction;
  24. use ApiPlatform\Util\RequestAttributesExtractor;
  25. use Symfony\Component\HttpFoundation\Request;
  26. use Symfony\Component\HttpFoundation\Response;
  27. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  28. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  29. use Twig\Environment as TwigEnvironment;
  31. /**
  32.  * Displays the documentation.
  33.  *
  34.  * @deprecated please refer to ApiPlatform\Symfony\Bundle\SwaggerUi\SwaggerUiAction for further changes
  35.  *
  36.  * @author Kévin Dunglas <dunglas@gmail.com>
  37.  */
  38. final class SwaggerUiAction
  39. {
  40.     private $resourceNameCollectionFactory;
  41.     /** @var ResourceMetadataFactoryInterface|ResourceMetadataCollectionFactoryInterface */
  42.     private $resourceMetadataFactory;
  43.     private $normalizer;
  44.     private $twig;
  45.     private $urlGenerator;
  46.     private $title;
  47.     private $description;
  48.     private $version;
  49.     private $showWebby;
  50.     private $formats;
  51.     private $oauthEnabled;
  52.     private $oauthClientId;
  53.     private $oauthClientSecret;
  54.     private $oauthType;
  55.     private $oauthFlow;
  56.     private $oauthTokenUrl;
  57.     private $oauthAuthorizationUrl;
  58.     private $oauthScopes;
  59.     private $oauthPkce;
  60.     private $formatsProvider;
  61.     private $swaggerUiEnabled;
  62.     private $reDocEnabled;
  63.     private $graphqlEnabled;
  64.     private $graphiQlEnabled;
  65.     private $graphQlPlaygroundEnabled;
  66.     private $swaggerVersions;
  67.     private $swaggerUiAction;
  68.     private $assetPackage;
  69.     private $swaggerUiExtraConfiguration;
  71.     /**
  72.      * @param int[]      $swaggerVersions
  73.      * @param mixed|null $assetPackage
  74.      * @param mixed      $formats
  75.      * @param mixed      $oauthEnabled
  76.      * @param mixed      $oauthClientId
  77.      * @param mixed      $oauthClientSecret
  78.      * @param mixed      $oauthType
  79.      * @param mixed      $oauthFlow
  80.      * @param mixed      $oauthTokenUrl
  81.      * @param mixed      $oauthAuthorizationUrl
  82.      * @param mixed      $oauthScopes
  83.      * @param mixed      $resourceMetadataFactory
  84.      */
  85.     public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, $resourceMetadataFactory, NormalizerInterface $normalizer, ?TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '', string $version = '', $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthScopes = [], bool $showWebby = true, bool $swaggerUiEnabled = false, bool $reDocEnabled = false, bool $graphqlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false, array $swaggerVersions = [2, 3], OpenApiSwaggerUiAction $swaggerUiAction = null, $assetPackage = null, array $swaggerUiExtraConfiguration = [], bool $oauthPkce = false)
  86.     {
  87.         $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  88.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  89.         $this->normalizer = $normalizer;
  90.         $this->twig = $twig;
  91.         $this->urlGenerator = $urlGenerator;
  92.         $this->title = $title;
  93.         $this->showWebby = $showWebby;
  94.         $this->description = $description;
  95.         $this->version = $version;
  96.         $this->oauthEnabled = $oauthEnabled;
  97.         $this->oauthClientId = $oauthClientId;
  98.         $this->oauthClientSecret = $oauthClientSecret;
  99.         $this->oauthType = $oauthType;
  100.         $this->oauthFlow = $oauthFlow;
  101.         $this->oauthTokenUrl = $oauthTokenUrl;
  102.         $this->oauthAuthorizationUrl = $oauthAuthorizationUrl;
  103.         $this->oauthScopes = $oauthScopes;
  104.         $this->swaggerUiEnabled = $swaggerUiEnabled;
  105.         $this->reDocEnabled = $reDocEnabled;
  106.         $this->graphqlEnabled = $graphqlEnabled;
  107.         $this->graphiQlEnabled = $graphiQlEnabled;
  108.         $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;
  109.         $this->swaggerVersions = $swaggerVersions;
  110.         $this->swaggerUiAction = $swaggerUiAction;
  111.         $this->swaggerUiExtraConfiguration = $swaggerUiExtraConfiguration;
  112.         $this->assetPackage = $assetPackage;
  113.         $this->oauthPkce = $oauthPkce;
  115.         if (null === $this->twig) {
  116.             throw new \RuntimeException('The documentation cannot be displayed since the Twig bundle is not installed. Try running "composer require symfony/twig-bundle".');
  117.         }
  119.         if (null === $this->swaggerUiAction) {
  120.             @trigger_error(sprintf('The use of "%s" is deprecated since API Platform 2.6, use "%s" instead.', __CLASS__, OpenApiSwaggerUiAction::class), \E_USER_DEPRECATED);
  121.         }
  123.         if (\is_array($formats)) {
  124.             $this->formats = $formats;
  126.             return;
  127.         }
  129.         @trigger_error(sprintf('Passing an array or an instance of "%s" as 5th parameter of the constructor of "%s" is deprecated since API Platform 2.5, pass an array instead', FormatsProviderInterface::class, __CLASS__), \E_USER_DEPRECATED);
  130.         $this->formatsProvider = $formats;
  131.     }
  133.     public function __invoke(Request $request)
  134.     {
  135.         if ($this->swaggerUiAction) {
  136.             return $this->swaggerUiAction->__invoke($request);
  137.         }
  139.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  141.         // BC check to be removed in 3.0
  142.         if (null === $this->formatsProvider) {
  143.             $formats = $attributes ? $this
  144.                 ->resourceMetadataFactory
  145.                 ->create($attributes['resource_class'])
  146.                 ->getOperationAttribute($attributes, 'output_formats', [], true) : $this->formats;
  147.         } else {
  148.             $formats = $this->formatsProvider->getFormatsFromAttributes($attributes);
  149.         }
  151.         $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version);
  153.         return new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $this->getContext($request, $documentation) + ['formats' => $formats]));
  154.     }
  156.     /**
  157.      * Gets the base Twig context.
  158.      */
  159.     private function getContext(Request $request, Documentation $documentation): array
  160.     {
  161.         $context = [
  162.             'title' => $this->title,
  163.             'description' => $this->description,
  164.             'showWebby' => $this->showWebby,
  165.             'swaggerUiEnabled' => $this->swaggerUiEnabled,
  166.             'reDocEnabled' => $this->reDocEnabled,
  167.             'graphqlEnabled' => $this->graphqlEnabled,
  168.             'graphiQlEnabled' => $this->graphiQlEnabled,
  169.             'graphQlPlaygroundEnabled' => $this->graphQlPlaygroundEnabled,
  170.             'assetPackage' => $this->assetPackage,
  171.         ];
  173.         $swaggerContext = ['spec_version' => $request->query->getInt('spec_version', $this->swaggerVersions[0] ?? 2)];
  174.         if ('' !== $baseUrl = $request->getBaseUrl()) {
  175.             $swaggerContext['base_url'] = $baseUrl;
  176.         }
  178.         $swaggerData = [
  179.             'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
  180.             'spec' => $this->normalizer->normalize($documentation, 'json', $swaggerContext),
  181.             'extraConfiguration' => $this->swaggerUiExtraConfiguration,
  182.         ];
  184.         $swaggerData['oauth'] = [
  185.             'enabled' => $this->oauthEnabled,
  186.             'clientId' => $this->oauthClientId,
  187.             'clientSecret' => $this->oauthClientSecret,
  188.             'pkce' => $this->oauthPkce,
  189.             'type' => $this->oauthType,
  190.             'flow' => $this->oauthFlow,
  191.             'tokenUrl' => $this->oauthTokenUrl,
  192.             'authorizationUrl' => $this->oauthAuthorizationUrl,
  193.             'scopes' => $this->oauthScopes,
  194.         ];
  196.         if ($request->isMethodSafe() && null !== $resourceClass = $request->attributes->get('_api_resource_class')) {
  197.             $swaggerData['id'] = $request->attributes->get('id');
  198.             $swaggerData['queryParameters'] = $request->query->all();
  200.             $metadata = $this->resourceMetadataFactory->create($resourceClass);
  201.             $swaggerData['shortName'] = $metadata instanceof ResourceMetadata ? $metadata->getShortName() : $metadata[0]->getShortName();
  203.             if (null !== $collectionOperationName = $request->attributes->get('_api_collection_operation_name')) {
  204.                 $swaggerData['operationId'] = sprintf('%s%sCollection', $collectionOperationName, ucfirst($swaggerData['shortName']));
  205.             } elseif (null !== $itemOperationName = $request->attributes->get('_api_item_operation_name')) {
  206.                 $swaggerData['operationId'] = sprintf('%s%sItem', $itemOperationName, ucfirst($swaggerData['shortName']));
  207.             } elseif (null !== $subresourceOperationContext = $request->attributes->get('_api_subresource_context')) {
  208.                 $swaggerData['operationId'] = $subresourceOperationContext['operationId'];
  209.             }
  211.             [$swaggerData['path'], $swaggerData['method']] = $this->getPathAndMethod($swaggerData);
  212.         }
  214.         return $context + ['swagger_data' => $swaggerData];
  215.     }
  217.     private function getPathAndMethod(array $swaggerData): array
  218.     {
  219.         foreach ($swaggerData['spec']['paths'] as $path => $operations) {
  220.             foreach ($operations as $method => $operation) {
  221.                 if ($operation['operationId'] === $swaggerData['operationId']) {
  222.                     return [$path, $method];
  223.                 }
  224.             }
  225.         }
  227.         throw new RuntimeException(sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));
  228.     }
  229. }