vendor/api-platform/core/src/Documentation/Action/DocumentationAction.php line 29

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\Documentation\Action;
  16. use ApiPlatform\Core\Api\FormatsProviderInterface;
  17. use ApiPlatform\Core\Documentation\Documentation;
  18. use ApiPlatform\Core\Documentation\DocumentationInterface;
  19. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  20. use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface;
  21. use ApiPlatform\Core\Util\RequestAttributesExtractor;
  22. use Symfony\Component\HttpFoundation\Request;
  24. /**
  25.  * Generates the API documentation.
  26.  *
  27.  * @author Amrouche Hamza <hamza.simperfit@gmail.com>
  28.  */
  29. final class DocumentationAction
  30. {
  31.     private $resourceNameCollectionFactory;
  32.     private $title;
  33.     private $description;
  34.     private $version;
  35.     private $formats;
  36.     private $formatsProvider;
  37.     private $swaggerVersions;
  38.     private $openApiFactory;
  40.     /**
  41.      * @param int[]                                $swaggerVersions
  42.      * @param mixed|array|FormatsProviderInterface $formatsProvider
  43.      */
  44.     public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, string $title = '', string $description = '', string $version = '', $formatsProvider = null, array $swaggerVersions = [2, 3], OpenApiFactoryInterface $openApiFactory = null)
  45.     {
  46.         $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  47.         $this->title = $title;
  48.         $this->description = $description;
  49.         $this->version = $version;
  50.         $this->swaggerVersions = $swaggerVersions;
  51.         $this->openApiFactory = $openApiFactory;
  53.         if (null === $openApiFactory) {
  54.             @trigger_error(sprintf('Not passing an instance of "%s" as 7th parameter of the constructor of "%s" is deprecated since API Platform 2.6', OpenApiFactoryInterface::class, __CLASS__), \E_USER_DEPRECATED);
  55.         }
  57.         if (null === $formatsProvider) {
  58.             return;
  59.         }
  61.         @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', FormatsProviderInterface::class, __CLASS__), \E_USER_DEPRECATED);
  62.         if (\is_array($formatsProvider)) {
  63.             $this->formats = $formatsProvider;
  65.             return;
  66.         }
  68.         $this->formatsProvider = $formatsProvider;
  69.     }
  71.     public function __invoke(Request $request = null): DocumentationInterface
  72.     {
  73.         if (null !== $request) {
  74.             $context = ['base_url' => $request->getBaseUrl(), 'spec_version' => $request->query->getInt('spec_version', $this->swaggerVersions[0] ?? 3)];
  75.             if ($request->query->getBoolean('api_gateway')) {
  76.                 $context['api_gateway'] = true;
  77.             }
  78.             $request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + $context);
  80.             $attributes = RequestAttributesExtractor::extractAttributes($request);
  81.         }
  83.         // BC check to be removed in 3.0
  84.         if (null !== $this->formatsProvider) {
  85.             $this->formats = $this->formatsProvider->getFormatsFromAttributes($attributes ?? []);
  86.         }
  88.         if ('json' === $request->getRequestFormat() && null !== $this->openApiFactory && 3 === ($context['spec_version'] ?? null)) {
  89.             return $this->openApiFactory->__invoke($context ?? []);
  90.         }
  92.         return new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version, $this->formats);
  93.     }
  94. }