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

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\Core\Api\FormatsProviderInterface;
  17. use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface as LegacyOpenApiFactoryInterface;
  18. use ApiPlatform\Documentation\Documentation;
  19. use ApiPlatform\Documentation\DocumentationInterface;
  20. use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
  21. use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
  22. use ApiPlatform\Util\RequestAttributesExtractor;
  23. use Symfony\Component\HttpFoundation\Request;
  25. /**
  26. * Generates the API documentation.
  27. *
  28. * @author Amrouche Hamza <hamza.simperfit@gmail.com>
  29. */
  30. final class DocumentationAction
  31. {
  32. private $resourceNameCollectionFactory;
  33. private $title;
  34. private $description;
  35. private $version;
  36. private $formats;
  37. private $formatsProvider;
  38. private $swaggerVersions;
  39. private $openApiFactory;
  41. /**
  42. * @param int[] $swaggerVersions
  43. * @param mixed|array|FormatsProviderInterface $formatsProvider
  44. * @param LegacyOpenApiFactoryInterface|OpenApiFactoryInterface $openApiFactory
  45. */
  46. public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, string $title = '', string $description = '', string $version = '', $formatsProvider = null, array $swaggerVersions = [2, 3], $openApiFactory = null)
  47. {
  48. $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
  49. $this->title = $title;
  50. $this->description = $description;
  51. $this->version = $version;
  52. $this->swaggerVersions = $swaggerVersions;
  53. $this->openApiFactory = $openApiFactory;
  55. if (null === $openApiFactory) {
  56. @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);
  57. }
  59. if (null === $formatsProvider) {
  60. return;
  61. }
  63. @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);
  64. if (\is_array($formatsProvider)) {
  65. $this->formats = $formatsProvider;
  67. return;
  68. }
  70. $this->formatsProvider = $formatsProvider;
  71. }
  73. public function __invoke(Request $request = null): DocumentationInterface
  74. {
  75. if (null !== $request) {
  76. $context = ['base_url' => $request->getBaseUrl(), 'spec_version' => $request->query->getInt('spec_version', $this->swaggerVersions[0] ?? 3)];
  77. if ($request->query->getBoolean('api_gateway')) {
  78. $context['api_gateway'] = true;
  79. }
  80. $request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + $context);
  82. $attributes = RequestAttributesExtractor::extractAttributes($request);
  83. }
  85. // BC check to be removed in 3.0
  86. if (null !== $this->formatsProvider) {
  87. $this->formats = $this->formatsProvider->getFormatsFromAttributes($attributes ?? []);
  88. }
  90. if ('json' === $request->getRequestFormat() && null !== $this->openApiFactory && 3 === ($context['spec_version'] ?? null)) {
  91. return $this->openApiFactory->__invoke($context);
  92. }
  94. return new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version, $this->formats);
  95. }
  96. }
  98. class_alias(DocumentationAction::class, \ApiPlatform\Core\Documentation\Action\DocumentationAction::class);