Newer
Older
Klaranouba7
a validé
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?php
/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace ApiPlatform\Core\Documentation\Action;
use ApiPlatform\Core\Api\FormatsProviderInterface;
use ApiPlatform\Core\Documentation\Documentation;
use ApiPlatform\Core\Documentation\DocumentationInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use Symfony\Component\HttpFoundation\Request;
/**
* Generates the API documentation.
*
* @author Amrouche Hamza <hamza.simperfit@gmail.com>
*/
final class DocumentationAction
{
private $resourceNameCollectionFactory;
private $title;
private $description;
private $version;
private $formats;
private $formatsProvider;
private $swaggerVersions;
private $openApiFactory;
/**
* @param int[] $swaggerVersions
* @param mixed|array|FormatsProviderInterface $formatsProvider
*/
public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, string $title = '', string $description = '', string $version = '', $formatsProvider = null, array $swaggerVersions = [2, 3], OpenApiFactoryInterface $openApiFactory = null)
{
$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
$this->title = $title;
$this->description = $description;
$this->version = $version;
$this->swaggerVersions = $swaggerVersions;
$this->openApiFactory = $openApiFactory;
if (null === $openApiFactory) {
@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);
}
if (null === $formatsProvider) {
return;
}
@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);
if (\is_array($formatsProvider)) {
$this->formats = $formatsProvider;
return;
}
$this->formatsProvider = $formatsProvider;
}
public function __invoke(Request $request = null): DocumentationInterface
{
if (null !== $request) {
$context = ['base_url' => $request->getBaseUrl(), 'spec_version' => $request->query->getInt('spec_version', $this->swaggerVersions[0] ?? 3)];
if ($request->query->getBoolean('api_gateway')) {
$context['api_gateway'] = true;
}
$request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + $context);
$attributes = RequestAttributesExtractor::extractAttributes($request);
}
// BC check to be removed in 3.0
if (null !== $this->formatsProvider) {
$this->formats = $this->formatsProvider->getFormatsFromAttributes($attributes ?? []);
}
if ('json' === $request->getRequestFormat() && null !== $this->openApiFactory && 3 === ($context['spec_version'] ?? null)) {
return $this->openApiFactory->__invoke($context ?? []);
}
return new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version, $this->formats);
}
}