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

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\Documentation\Action;
  16. use ApiPlatform\Documentation\Documentation;
  17. use ApiPlatform\Documentation\DocumentationInterface;
  18. use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  19. use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
  20. use Symfony\Component\HttpFoundation\Request;
  22. /**
  23.  * Generates the API documentation.
  24.  *
  25.  * @author Amrouche Hamza <hamza.simperfit@gmail.com>
  26.  */
  27. final class DocumentationAction
  28. {
  29.     public function __construct(private readonly ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, private readonly string $title = '', private readonly string $description = '', private readonly string $version = '', private readonly ?OpenApiFactoryInterface $openApiFactory = null)
  30.     {
  31.     }
  33.     public function __invoke(Request $request = null): DocumentationInterface
  34.     {
  35.         if (null !== $request) {
  36.             $context = ['base_url' => $request->getBaseUrl()];
  37.             if ($request->query->getBoolean('api_gateway')) {
  38.                 $context['api_gateway'] = true;
  39.             }
  40.             $request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + $context);
  41.         }
  43.         if ('json' === $request?->getRequestFormat() && null !== $this->openApiFactory) {
  44.             return $this->openApiFactory->__invoke($context ?? []);
  45.         }
  47.         return new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version);
  48.     }
  49. }