Symfony Profiler

<?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\Symfony\Bundle\SwaggerUi;
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use ApiPlatform\Exception\RuntimeException;
use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
use ApiPlatform\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;
private $oauthPkce;
public function __construct($resourceMetadataFactory, ?TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, NormalizerInterface $normalizer, OpenApiFactoryInterface $openApiFactory, Options $openApiOptions, SwaggerUiContext $swaggerUiContext, array $formats = [], string $oauthClientId = null, string $oauthClientSecret = null, bool $oauthPkce = false)
{
$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;
$this->oauthPkce = $oauthPkce;
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".');
}
}
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,
'pkce' => $this->oauthPkce,
],
'extraConfiguration' => $this->swaggerUiContext->getExtraConfiguration(),
];
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);
if ($metadata instanceof ResourceMetadata) {
$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'];
}
} else {
$swaggerData['shortName'] = $metadata[0]->getShortName();
$swaggerData['operationId'] = $request->attributes->get('_api_operation_name');
}
[$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']));
}
}
class_alias(SwaggerUiAction::class, \ApiPlatform\Core\Bridge\Symfony\Bundle\SwaggerUi\SwaggerUiAction::class);

vendor/api-platform/core/src/Symfony/Bundle/SwaggerUi/SwaggerUiAction.php line 64