vendor/nelmio/api-doc-bundle/ApiDocGenerator.php line 101

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the NelmioApiDocBundle package.
  5.  *
  6.  * (c) Nelmio
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Nelmio\ApiDocBundle;
  14. use Nelmio\ApiDocBundle\Describer\DescriberInterface;
  15. use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface;
  16. use Nelmio\ApiDocBundle\Model\ModelRegistry;
  17. use Nelmio\ApiDocBundle\ModelDescriber\ModelDescriberInterface;
  18. use Nelmio\ApiDocBundle\OpenApiPhp\ModelRegister;
  19. use Nelmio\ApiDocBundle\OpenApiPhp\Util;
  20. use OpenApi\Analysis;
  21. use OpenApi\Annotations\OpenApi;
  22. use OpenApi\Generator;
  23. use Psr\Cache\CacheItemPoolInterface;
  24. use Psr\Log\LoggerAwareTrait;
  26. final class ApiDocGenerator
  27. {
  28.     use LoggerAwareTrait;
  30.     /** @var OpenApi */
  31.     private $openApi;
  33.     /** @var iterable|DescriberInterface[] */
  34.     private $describers;
  36.     /** @var iterable|ModelDescriberInterface[] */
  37.     private $modelDescribers;
  39.     /** @var CacheItemPoolInterface|null */
  40.     private $cacheItemPool;
  42.     /** @var string|null */
  43.     private $cacheItemId;
  45.     /** @var string[] */
  46.     private $alternativeNames = [];
  48.     /** @var string[] */
  49.     private $mediaTypes = ['json'];
  51.     /**
  52.      * @param DescriberInterface[]|iterable      $describers
  53.      * @param ModelDescriberInterface[]|iterable $modelDescribers
  54.      */
  55.     public function __construct($describers, $modelDescribers, CacheItemPoolInterface $cacheItemPool = null, string $cacheItemId = null)
  56.     {
  57.         $this->describers = $describers;
  58.         $this->modelDescribers = $modelDescribers;
  59.         $this->cacheItemPool = $cacheItemPool;
  60.         $this->cacheItemId = $cacheItemId;
  61.     }
  63.     public function setAlternativeNames(array $alternativeNames)
  64.     {
  65.         $this->alternativeNames = $alternativeNames;
  66.     }
  68.     public function setMediaTypes(array $mediaTypes)
  69.     {
  70.         $this->mediaTypes = $mediaTypes;
  71.     }
  73.     public function generate(): OpenApi
  74.     {
  75.         if (null !== $this->openApi) {
  76.             return $this->openApi;
  77.         }
  79.         if ($this->cacheItemPool) {
  80.             $item = $this->cacheItemPool->getItem($this->cacheItemId ?? 'openapi_doc');
  81.             if ($item->isHit()) {
  82.                 return $this->openApi = $item->get();
  83.             }
  84.         }
  86.         $generator = new Generator();
  87.         // Remove OperationId processor as we use a lot of generated annotations which do not have enough information in their context
  88.         // to generate these ids properly.
  89.         // @see https://github.com/zircote/swagger-php/issues/1153
  90.         $generator->setProcessors(array_filter($generator->getProcessors(), function ($processor) {
  91.             return !$processor instanceof \OpenApi\Processors\OperationId;
  92.         }));
  94.         $context = Util::createContext(['version' => $generator->getVersion()]);
  96.         $this->openApi = new OpenApi(['_context' => $context]);
  97.         $modelRegistry = new ModelRegistry($this->modelDescribers, $this->openApi, $this->alternativeNames);
  98.         if (null !== $this->logger) {
  99.             $modelRegistry->setLogger($this->logger);
  100.         }
  101.         foreach ($this->describers as $describer) {
  102.             if ($describer instanceof ModelRegistryAwareInterface) {
  103.                 $describer->setModelRegistry($modelRegistry);
  104.             }
  106.             $describer->describe($this->openApi);
  107.         }
  109.         $analysis = new Analysis([], $context);
  110.         $analysis->addAnnotation($this->openApi, $context);
  112.         // Register model annotations
  113.         $modelRegister = new ModelRegister($modelRegistry, $this->mediaTypes);
  114.         $modelRegister($analysis);
  116.         // Calculate the associated schemas
  117.         $modelRegistry->registerSchemas();
  119.         $analysis->process($generator->getProcessors());
  120.         $analysis->validate();
  122.         if (isset($item)) {
  123.             $this->cacheItemPool->save($item->set($this->openApi));
  124.         }
  126.         return $this->openApi;
  127.     }
  128. }