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

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