#26977

pending completion

Build # #26977

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/af9f7dd9b1d4ebe11877b9222bb844547eccd532">af9f7dd9b<a href="https://github.com/api-platform/core/commit/af9f7dd9b1d4ebe11877b9222bb844547eccd532">">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/2894404f791e82549bf9ef8a12deea2d36eb427c">2894404f7</a>">2894404f7</a><a href="https://github.com/api-platform/core/commit/af9f7dd9b1d4ebe11877b9222bb844547eccd532"> into fc15953b9">fc15953b9</a>

Run Details

4 of 4 new or added lines in 2 files covered. (100.0%)

9617 of 11580 relevant lines covered (83.05%)

14.41 hits per line

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

92.31

/src/Bridge/Symfony/Bundle/SwaggerUi/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\SwaggerUi;

use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\Core\OpenApi\Options;
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 swaggerui interface.
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 */
final class SwaggerUiAction
{
    private $twig;
    private $urlGenerator;
    private $normalizer;
    private $openApiFactory;
    private $openApiOptions;
    private $swaggerUiContext;
    private $formats;
    private $resourceMetadataFactory;
    private $oauthClientId;
    private $oauthClientSecret;

    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, ?TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, NormalizerInterface $normalizer, OpenApiFactoryInterface $openApiFactory, Options $openApiOptions, SwaggerUiContext $swaggerUiContext, array $formats = [], string $oauthClientId = null, string $oauthClientSecret = null)
    {
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->twig = $twig;
        $this->urlGenerator = $urlGenerator;
        $this->normalizer = $normalizer;
        $this->openApiFactory = $openApiFactory;
        $this->openApiOptions = $openApiOptions;
        $this->swaggerUiContext = $swaggerUiContext;
        $this->formats = $formats;
        $this->oauthClientId = $oauthClientId;
        $this->oauthClientSecret = $oauthClientSecret;

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

    public function __invoke(Request $request)
    {
        $openApi = $this->openApiFactory->__invoke(['base_url' => $request->getBaseUrl() ?: '/']);

        $swaggerContext = [
            'formats' => $this->formats,
            'title' => $openApi->getInfo()->getTitle(),
            'description' => $openApi->getInfo()->getDescription(),
            'showWebby' => $this->swaggerUiContext->isWebbyShown(),
            'swaggerUiEnabled' => $this->swaggerUiContext->isSwaggerUiEnabled(),
            'reDocEnabled' => $this->swaggerUiContext->isRedocEnabled(),
            // FIXME: typo graphql => graphQl
            'graphqlEnabled' => $this->swaggerUiContext->isGraphQlEnabled(),
            'graphiQlEnabled' => $this->swaggerUiContext->isGraphiQlEnabled(),
            'graphQlPlaygroundEnabled' => $this->swaggerUiContext->isGraphQlPlaygroundEnabled(),
            'assetPackage' => $this->swaggerUiContext->getAssetPackage(),
        ];

        $swaggerData = [
            'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
            'spec' => $this->normalizer->normalize($openApi, 'json', []),
            'oauth' => [
                'enabled' => $this->openApiOptions->getOAuthEnabled(),
                'type' => $this->openApiOptions->getOAuthType(),
                'flow' => $this->openApiOptions->getOAuthFlow(),
                'tokenUrl' => $this->openApiOptions->getOAuthTokenUrl(),
                'authorizationUrl' => $this->openApiOptions->getOAuthAuthorizationUrl(),
                'scopes' => $this->openApiOptions->getOAuthScopes(),
                'clientId' => $this->oauthClientId,
                'clientSecret' => $this->oauthClientSecret,
            ],
        ];

        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 new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $swaggerContext + ['swagger_data' => $swaggerData]));
    }

    private function getPathAndMethod(array $swaggerData): array
    {
        foreach ($swaggerData['spec']['paths'] as $path => $operations) {
            foreach ($operations as $method => $operation) {
                if (($operation['operationId'] ?? null) === $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\SwaggerUi;
15
16	use ApiPlatform\Core\Exception\RuntimeException;
17	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
18	use ApiPlatform\Core\OpenApi\Factory\OpenApiFactoryInterface;
19	use ApiPlatform\Core\OpenApi\Options;
20	use Symfony\Component\HttpFoundation\Request;
21	use Symfony\Component\HttpFoundation\Response;
22	use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
23	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
24	use Twig\Environment as TwigEnvironment;
25
26	/**
27	* Displays the swaggerui interface.
28	*
29	* @author Antoine Bluchet <soyuka@gmail.com>
30	*/
31	final class SwaggerUiAction
32	{
33	private $twig;
34	private $urlGenerator;
35	private $normalizer;
36	private $openApiFactory;
37	private $openApiOptions;
38	private $swaggerUiContext;
39	private $formats;
40	private $resourceMetadataFactory;
41	private $oauthClientId;
42	private $oauthClientSecret;
43
44	public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, ?TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, NormalizerInterface $normalizer, OpenApiFactoryInterface $openApiFactory, Options $openApiOptions, SwaggerUiContext $swaggerUiContext, array $formats = [], string $oauthClientId = null, string $oauthClientSecret = null)
45	{
46	$this->resourceMetadataFactory = $resourceMetadataFactory;	5✔
47	$this->twig = $twig;	5✔
48	$this->urlGenerator = $urlGenerator;	5✔
49	$this->normalizer = $normalizer;	5✔
50	$this->openApiFactory = $openApiFactory;	5✔
51	$this->openApiOptions = $openApiOptions;	5✔
52	$this->swaggerUiContext = $swaggerUiContext;	5✔
53	$this->formats = $formats;	5✔
54	$this->oauthClientId = $oauthClientId;	5✔
55	$this->oauthClientSecret = $oauthClientSecret;	5✔
56
57	if (null === $this->twig) {	5✔
58	throw new \RuntimeException('You cannot use the "twig" service since the Twig bundle is not installed. Try running "composer require symfony/twig-bundle".');	×
59	}
60	}	5✔
61
62	public function __invoke(Request $request)
63	{
64	$openApi = $this->openApiFactory->__invoke(['base_url' => $request->getBaseUrl() ?: '/']);	5✔
65
66	$swaggerContext = [
67	'formats' => $this->formats,	5✔
68	'title' => $openApi->getInfo()->getTitle(),	5✔
69	'description' => $openApi->getInfo()->getDescription(),	5✔
70	'showWebby' => $this->swaggerUiContext->isWebbyShown(),	5✔
71	'swaggerUiEnabled' => $this->swaggerUiContext->isSwaggerUiEnabled(),	5✔
72	'reDocEnabled' => $this->swaggerUiContext->isRedocEnabled(),	5✔
73	// FIXME: typo graphql => graphQl
74	'graphqlEnabled' => $this->swaggerUiContext->isGraphQlEnabled(),	5✔
75	'graphiQlEnabled' => $this->swaggerUiContext->isGraphiQlEnabled(),	5✔
76	'graphQlPlaygroundEnabled' => $this->swaggerUiContext->isGraphQlPlaygroundEnabled(),	5✔
77	'assetPackage' => $this->swaggerUiContext->getAssetPackage(),	5✔
78	];
79
80	$swaggerData = [
81	'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),	5✔
82	'spec' => $this->normalizer->normalize($openApi, 'json', []),	5✔
83	'oauth' => [
84	'enabled' => $this->openApiOptions->getOAuthEnabled(),	5✔
85	'type' => $this->openApiOptions->getOAuthType(),	5✔
86	'flow' => $this->openApiOptions->getOAuthFlow(),	5✔
87	'tokenUrl' => $this->openApiOptions->getOAuthTokenUrl(),	5✔
88	'authorizationUrl' => $this->openApiOptions->getOAuthAuthorizationUrl(),	5✔
89	'scopes' => $this->openApiOptions->getOAuthScopes(),	5✔
90	'clientId' => $this->oauthClientId,	5✔
91	'clientSecret' => $this->oauthClientSecret,	5✔
92	],
93	];
94
95	if ($request->isMethodSafe() && null !== $resourceClass = $request->attributes->get('_api_resource_class')) {	5✔
96	$swaggerData['id'] = $request->attributes->get('id');	3✔
97	$swaggerData['queryParameters'] = $request->query->all();	3✔
98
99	$metadata = $this->resourceMetadataFactory->create($resourceClass);	3✔
100	$swaggerData['shortName'] = $metadata->getShortName();	3✔
101
102	if (null !== $collectionOperationName = $request->attributes->get('_api_collection_operation_name')) {	3✔
103	$swaggerData['operationId'] = sprintf('%s%sCollection', $collectionOperationName, ucfirst($swaggerData['shortName']));	1✔
104	} elseif (null !== $itemOperationName = $request->attributes->get('_api_item_operation_name')) {	2✔
105	$swaggerData['operationId'] = sprintf('%s%sItem', $itemOperationName, ucfirst($swaggerData['shortName']));	2✔
106	} elseif (null !== $subresourceOperationContext = $request->attributes->get('_api_subresource_context')) {	×
107	$swaggerData['operationId'] = $subresourceOperationContext['operationId'];	×
108	}
109
110	[$swaggerData['path'], $swaggerData['method']] = $this->getPathAndMethod($swaggerData);	3✔
111	}
112
113	return new Response($this->twig->render('@ApiPlatform/SwaggerUi/index.html.twig', $swaggerContext + ['swagger_data' => $swaggerData]));	5✔
114	}
115
116	private function getPathAndMethod(array $swaggerData): array
117	{
118	foreach ($swaggerData['spec']['paths'] as $path => $operations) {	3✔
119	foreach ($operations as $method => $operation) {	3✔
120	if (($operation['operationId'] ?? null) === $swaggerData['operationId']) {	3✔
121	return [$path, $method];	3✔
122	}
123	}
124	}
125
126	throw new RuntimeException(sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));	×
127	}
128	}

api-platform / core / #26977

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