mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 23:59:26 +03:00
78664ef9ec
* Initial pass for OA3 upgrade * Fix Util Tests * Fix first batch of Unit Tests. Up to Model * Another batch of fixed tests * Update annotations * Convert Model & Property Describers * Update tests, Fix RouteDescribers, FIx additional bugs * Another batch of updates * Another batch of fixed Functional Tests * Fix FunctionalTest tests * Fix Bazinga Tests * FIx FOS Rest * Fix JMS TEsts & describers * Fix all Tests * Fix few stuff from own CR * CS Fixes * CS Fixes 2 * CS Fixes 3 * CS Fixes 4 * Remove collection bug * Updates after first CRs * CS * Drop support for SF3 * Update the docs * Add an upgrade guide * misc doc fixes * Configurable media types * Code Style Fixes * Don't use ::$ref for @Response and @RequestBody * Fix upgrading guide * Fix OA case Co-authored-by: Filip Benčo <filip.benco@websupport.sk> Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com> Co-authored-by: Mantis Development <mantis@users.noreply.github.com>
82 lines
3.0 KiB
PHP
82 lines
3.0 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the NelmioApiDocBundle package.
|
|
*
|
|
* (c) Nelmio
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Nelmio\ApiDocBundle\Controller;
|
|
|
|
use Nelmio\ApiDocBundle\ApiDocGenerator;
|
|
use OpenApi\Annotations\OpenApi;
|
|
use OpenApi\Annotations\Server;
|
|
use Psr\Container\ContainerInterface;
|
|
use Symfony\Component\DependencyInjection\ServiceLocator;
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
use Symfony\Component\HttpFoundation\Response;
|
|
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
|
|
use Twig\Environment;
|
|
|
|
final class SwaggerUiController
|
|
{
|
|
private $generatorLocator;
|
|
|
|
private $twig;
|
|
|
|
/**
|
|
* @param ContainerInterface $generatorLocator
|
|
*/
|
|
public function __construct($generatorLocator, $twig)
|
|
{
|
|
if (!$twig instanceof \Twig_Environment && !$twig instanceof Environment) {
|
|
throw new \InvalidArgumentException(sprintf('Providing an instance of "%s" as twig is not supported.', get_class($twig)));
|
|
}
|
|
|
|
if (!$generatorLocator instanceof ContainerInterface) {
|
|
if (!$generatorLocator instanceof ApiDocGenerator) {
|
|
throw new \InvalidArgumentException(sprintf('Providing an instance of "%s" to "%s" is not supported.', get_class($generatorLocator), __METHOD__));
|
|
}
|
|
|
|
@trigger_error(sprintf('Providing an instance of "%s" to "%s()" is deprecated since version 3.1. Provide it an instance of "%s" instead.', ApiDocGenerator::class, __METHOD__, ContainerInterface::class), E_USER_DEPRECATED);
|
|
$generatorLocator = new ServiceLocator(['default' => function () use ($generatorLocator): ApiDocGenerator {
|
|
return $generatorLocator;
|
|
}]);
|
|
}
|
|
|
|
$this->generatorLocator = $generatorLocator;
|
|
$this->twig = $twig;
|
|
}
|
|
|
|
public function __invoke(Request $request, $area = 'default')
|
|
{
|
|
if (!$this->generatorLocator->has($area)) {
|
|
$advice = '';
|
|
if (false !== strpos($area, '.json')) {
|
|
$advice = ' Since the area provided contains `.json`, the issue is likely caused by route priorities. Try switching the Swagger UI / the json documentation routes order.';
|
|
}
|
|
|
|
throw new BadRequestHttpException(sprintf('Area "%s" is not supported as it isn\'t defined in config.%s', $area, $advice));
|
|
}
|
|
|
|
/** @var OpenApi $spec */
|
|
$spec = $this->generatorLocator->get($area)->generate();
|
|
|
|
if ('' !== $request->getBaseUrl()) {
|
|
$spec->servers = [new Server(['url' => $request->getSchemeAndHttpHost().$request->getBaseUrl()])];
|
|
}
|
|
|
|
return new Response(
|
|
$this->twig->render(
|
|
'@NelmioApiDoc/SwaggerUi/index.html.twig',
|
|
['swagger_data' => ['spec' => json_decode($spec->toJson(), true)]]
|
|
),
|
|
Response::HTTP_OK,
|
|
['Content-Type' => 'text/html']
|
|
);
|
|
}
|
|
}
|