#27378

pending completion

Build # #27378

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/7f4f0aac748a29111b282e2c41e5b7fe0ce65d99">7f4f0aac7<a href="https://github.com/api-platform/core/commit/7f4f0aac748a29111b282e2c41e5b7fe0ce65d99">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/604326debd882fc543dc3add7d3d143e4e7040d0">604326deb</a>">604326deb</a><a href="https://github.com/api-platform/core/commit/7f4f0aac748a29111b282e2c41e5b7fe0ce65d99"> into e32b4e88f">e32b4e88f</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

7551 of 12192 relevant lines covered (61.93%)

84.04 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

35.96

/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php

<?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\Bridge\Symfony\Bundle\Action;

use ApiPlatform\Core\Api\FormatsProviderInterface;
use ApiPlatform\Core\Bridge\Symfony\Bundle\SwaggerUi\SwaggerUiAction as OpenApiSwaggerUiAction;
use ApiPlatform\Core\Documentation\Documentation;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Twig\Environment as TwigEnvironment;

/**
 * Displays the documentation.
 *
 * @deprecated please refer to ApiPlatform\Core\Bridge\Symfony\Bundle\SwaggerUi\SwaggerUiAction for further changes
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class SwaggerUiAction
{
    private $resourceNameCollectionFactory;
    private $resourceMetadataFactory;
    private $normalizer;
    private $twig;
    private $urlGenerator;
    private $title;
    private $description;
    private $version;
    private $showWebby;
    private $formats;
    private $oauthEnabled;
    private $oauthClientId;
    private $oauthClientSecret;
    private $oauthType;
    private $oauthFlow;
    private $oauthTokenUrl;
    private $oauthAuthorizationUrl;
    private $oauthScopes;
    private $formatsProvider;
    private $swaggerUiEnabled;
    private $reDocEnabled;
    private $graphqlEnabled;
    private $graphiQlEnabled;
    private $graphQlPlaygroundEnabled;
    private $swaggerVersions;
    private $swaggerUiAction;
    private $assetPackage;

    /**
     * @param int[]      $swaggerVersions
     * @param mixed|null $assetPackage
     */
    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)
    {
        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->normalizer = $normalizer;
        $this->twig = $twig;
        $this->urlGenerator = $urlGenerator;
        $this->title = $title;
        $this->showWebby = $showWebby;
        $this->description = $description;
        $this->version = $version;
        $this->oauthEnabled = $oauthEnabled;
        $this->oauthClientId = $oauthClientId;
        $this->oauthClientSecret = $oauthClientSecret;
        $this->oauthType = $oauthType;
        $this->oauthFlow = $oauthFlow;
        $this->oauthTokenUrl = $oauthTokenUrl;
        $this->oauthAuthorizationUrl = $oauthAuthorizationUrl;
        $this->oauthScopes = $oauthScopes;
        $this->swaggerUiEnabled = $swaggerUiEnabled;
        $this->reDocEnabled = $reDocEnabled;
        $this->graphqlEnabled = $graphqlEnabled;
        $this->graphiQlEnabled = $graphiQlEnabled;
        $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;
        $this->swaggerVersions = $swaggerVersions;
        $this->swaggerUiAction = $swaggerUiAction;
        $this->assetPackage = $assetPackage;

        if (null === $this->twig) {
            throw new \RuntimeException('The documentation cannot be displayed since the Twig bundle is not installed. Try running "composer require symfony/twig-bundle".');
        }

        if (null === $this->swaggerUiAction) {
            @trigger_error(sprintf('The use of "%s" is deprecated since API Platform 2.6, use "%s" instead.', __CLASS__, OpenApiSwaggerUiAction::class), \E_USER_DEPRECATED);
        }

        if (\is_array($formats)) {
            $this->formats = $formats;

            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, pass an array instead', FormatsProviderInterface::class, __CLASS__), \E_USER_DEPRECATED);
        $this->formatsProvider = $formats;
    }

    public function __invoke(Request $request)
    {
        if ($this->swaggerUiAction) {
            return $this->swaggerUiAction->__invoke($request);
        }

        $attributes = RequestAttributesExtractor::extractAttributes($request);

        // BC check to be removed in 3.0
        if (null === $this->formatsProvider) {
            $formats = $attributes ? $this
                ->resourceMetadataFactory
                ->create($attributes['resource_class'])
                ->getOperationAttribute($attributes, 'output_formats', [], true) : $this->formats;
        } else {
            $formats = $this->formatsProvider->getFormatsFromAttributes($attributes);
        }

        $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version);

        return new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $this->getContext($request, $documentation) + ['formats' => $formats]));
    }

    /**
     * Gets the base Twig context.
     */
    private function getContext(Request $request, Documentation $documentation): array
    {
        $context = [
            'title' => $this->title,
            'description' => $this->description,
            'showWebby' => $this->showWebby,
            'swaggerUiEnabled' => $this->swaggerUiEnabled,
            'reDocEnabled' => $this->reDocEnabled,
            'graphqlEnabled' => $this->graphqlEnabled,
            'graphiQlEnabled' => $this->graphiQlEnabled,
            'graphQlPlaygroundEnabled' => $this->graphQlPlaygroundEnabled,
            'assetPackage' => $this->assetPackage,
        ];

        $swaggerContext = ['spec_version' => $request->query->getInt('spec_version', $this->swaggerVersions[0] ?? 2)];
        if ('' !== $baseUrl = $request->getBaseUrl()) {
            $swaggerContext['base_url'] = $baseUrl;
        }

        $swaggerData = [
            'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
            'spec' => $this->normalizer->normalize($documentation, 'json', $swaggerContext),
        ];

        $swaggerData['oauth'] = [
            'enabled' => $this->oauthEnabled,
            'clientId' => $this->oauthClientId,
            'clientSecret' => $this->oauthClientSecret,
            'type' => $this->oauthType,
            'flow' => $this->oauthFlow,
            'tokenUrl' => $this->oauthTokenUrl,
            'authorizationUrl' => $this->oauthAuthorizationUrl,
            'scopes' => $this->oauthScopes,
        ];

        if ($request->isMethodSafe() && null !== $resourceClass = $request->attributes->get('_api_resource_class')) {
            $swaggerData['id'] = $request->attributes->get('id');
            $swaggerData['queryParameters'] = $request->query->all();

            $metadata = $this->resourceMetadataFactory->create($resourceClass);
            $swaggerData['shortName'] = $metadata->getShortName();

            if (null !== $collectionOperationName = $request->attributes->get('_api_collection_operation_name')) {
                $swaggerData['operationId'] = sprintf('%s%sCollection', $collectionOperationName, ucfirst($swaggerData['shortName']));
            } elseif (null !== $itemOperationName = $request->attributes->get('_api_item_operation_name')) {
                $swaggerData['operationId'] = sprintf('%s%sItem', $itemOperationName, ucfirst($swaggerData['shortName']));
            } elseif (null !== $subresourceOperationContext = $request->attributes->get('_api_subresource_context')) {
                $swaggerData['operationId'] = $subresourceOperationContext['operationId'];
            }

            [$swaggerData['path'], $swaggerData['method']] = $this->getPathAndMethod($swaggerData);
        }

        return $context + ['swagger_data' => $swaggerData];
    }

    private function getPathAndMethod(array $swaggerData): array
    {
        foreach ($swaggerData['spec']['paths'] as $path => $operations) {
            foreach ($operations as $method => $operation) {
                if ($operation['operationId'] === $swaggerData['operationId']) {
                    return [$path, $method];
                }
            }
        }

        throw new RuntimeException(sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));
    }
}

1	<?php
2
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	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Action;
15
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;
28
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;
65
66	/**
67	* @param int[] $swaggerVersions
68	* @param mixed\|null $assetPackage
69	*/
70	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)
71	{
72	$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;	4✔
73	$this->resourceMetadataFactory = $resourceMetadataFactory;	4✔
74	$this->normalizer = $normalizer;	4✔
75	$this->twig = $twig;	4✔
76	$this->urlGenerator = $urlGenerator;	4✔
77	$this->title = $title;	4✔
78	$this->showWebby = $showWebby;	4✔
79	$this->description = $description;	4✔
80	$this->version = $version;	4✔
81	$this->oauthEnabled = $oauthEnabled;	4✔
82	$this->oauthClientId = $oauthClientId;	4✔
83	$this->oauthClientSecret = $oauthClientSecret;	4✔
84	$this->oauthType = $oauthType;	4✔
85	$this->oauthFlow = $oauthFlow;	4✔
86	$this->oauthTokenUrl = $oauthTokenUrl;	4✔
87	$this->oauthAuthorizationUrl = $oauthAuthorizationUrl;	4✔
88	$this->oauthScopes = $oauthScopes;	4✔
89	$this->swaggerUiEnabled = $swaggerUiEnabled;	4✔
90	$this->reDocEnabled = $reDocEnabled;	4✔
91	$this->graphqlEnabled = $graphqlEnabled;	4✔
92	$this->graphiQlEnabled = $graphiQlEnabled;	4✔
93	$this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;	4✔
94	$this->swaggerVersions = $swaggerVersions;	4✔
95	$this->swaggerUiAction = $swaggerUiAction;	4✔
96	$this->assetPackage = $assetPackage;	4✔
97
98	if (null === $this->twig) {	4✔
99	throw new \RuntimeException('The documentation cannot be displayed since the Twig bundle is not installed. Try running "composer require symfony/twig-bundle".');	×
100	}
101
102	if (null === $this->swaggerUiAction) {	4✔
103	@trigger_error(sprintf('The use of "%s" is deprecated since API Platform 2.6, use "%s" instead.', __CLASS__, OpenApiSwaggerUiAction::class), \E_USER_DEPRECATED);	×
104	}
105
106	if (\is_array($formats)) {	4✔
107	$this->formats = $formats;	4✔
108
109	return;	4✔
110	}
111
112	@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);	×
113	$this->formatsProvider = $formats;	×
114	}	×
115
116	public function __invoke(Request $request)
117	{
118	if ($this->swaggerUiAction) {	4✔
119	return $this->swaggerUiAction->__invoke($request);	4✔
120	}
121
122	$attributes = RequestAttributesExtractor::extractAttributes($request);	×
123
124	// BC check to be removed in 3.0
125	if (null === $this->formatsProvider) {	×
126	$formats = $attributes ? $this	×
127	->resourceMetadataFactory	×
128	->create($attributes['resource_class'])	×
129	->getOperationAttribute($attributes, 'output_formats', [], true) : $this->formats;	×
130	} else {
131	$formats = $this->formatsProvider->getFormatsFromAttributes($attributes);	×
132	}
133
134	$documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version);	×
135
136	return new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $this->getContext($request, $documentation) + ['formats' => $formats]));	×
137	}
138
139	/**
140	* Gets the base Twig context.
141	*/
142	private function getContext(Request $request, Documentation $documentation): array
143	{
144	$context = [	×
145	'title' => $this->title,	×
146	'description' => $this->description,	×
147	'showWebby' => $this->showWebby,	×
148	'swaggerUiEnabled' => $this->swaggerUiEnabled,	×
149	'reDocEnabled' => $this->reDocEnabled,	×
150	'graphqlEnabled' => $this->graphqlEnabled,	×
151	'graphiQlEnabled' => $this->graphiQlEnabled,	×
152	'graphQlPlaygroundEnabled' => $this->graphQlPlaygroundEnabled,	×
153	'assetPackage' => $this->assetPackage,	×
154	];
155
156	$swaggerContext = ['spec_version' => $request->query->getInt('spec_version', $this->swaggerVersions[0] ?? 2)];	×
157	if ('' !== $baseUrl = $request->getBaseUrl()) {	×
158	$swaggerContext['base_url'] = $baseUrl;	×
159	}
160
161	$swaggerData = [	×
162	'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),	×
163	'spec' => $this->normalizer->normalize($documentation, 'json', $swaggerContext),	×
164	];
165
166	$swaggerData['oauth'] = [	×
167	'enabled' => $this->oauthEnabled,	×
168	'clientId' => $this->oauthClientId,	×
169	'clientSecret' => $this->oauthClientSecret,	×
170	'type' => $this->oauthType,	×
171	'flow' => $this->oauthFlow,	×
172	'tokenUrl' => $this->oauthTokenUrl,	×
173	'authorizationUrl' => $this->oauthAuthorizationUrl,	×
174	'scopes' => $this->oauthScopes,	×
175	];
176
177	if ($request->isMethodSafe() && null !== $resourceClass = $request->attributes->get('_api_resource_class')) {	×
178	$swaggerData['id'] = $request->attributes->get('id');	×
179	$swaggerData['queryParameters'] = $request->query->all();	×
180
181	$metadata = $this->resourceMetadataFactory->create($resourceClass);	×
182	$swaggerData['shortName'] = $metadata->getShortName();	×
183
184	if (null !== $collectionOperationName = $request->attributes->get('_api_collection_operation_name')) {	×
185	$swaggerData['operationId'] = sprintf('%s%sCollection', $collectionOperationName, ucfirst($swaggerData['shortName']));	×
186	} elseif (null !== $itemOperationName = $request->attributes->get('_api_item_operation_name')) {	×
187	$swaggerData['operationId'] = sprintf('%s%sItem', $itemOperationName, ucfirst($swaggerData['shortName']));	×
188	} elseif (null !== $subresourceOperationContext = $request->attributes->get('_api_subresource_context')) {	×
189	$swaggerData['operationId'] = $subresourceOperationContext['operationId'];	×
190	}
191
192	[$swaggerData['path'], $swaggerData['method']] = $this->getPathAndMethod($swaggerData);	×
193	}
194
195	return $context + ['swagger_data' => $swaggerData];	×
196	}
197
198	private function getPathAndMethod(array $swaggerData): array
199	{
200	foreach ($swaggerData['spec']['paths'] as $path => $operations) {	×
201	foreach ($operations as $method => $operation) {	×
202	if ($operation['operationId'] === $swaggerData['operationId']) {	×
203	return [$path, $method];	×
204	}
205	}
206	}
207
208	throw new RuntimeException(sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));	×
209	}
210	}

api-platform / core / #27378

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous