vendor/harmbandstra/swagger-ui-bundle/src/Controller/DocsController.php line 41

Open in your IDE?
  1. <?php
  3. namespace HarmBandstra\SwaggerUiBundle\Controller;
  5. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  6. use Symfony\Component\Filesystem\Exception\FileNotFoundException;
  7. use Symfony\Component\HttpFoundation\JsonResponse;
  8. use Symfony\Component\HttpFoundation\RedirectResponse;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpFoundation\Response;
  11. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  12. use Symfony\Component\Yaml\Yaml;
  14. class DocsController extends AbstractController
  15. {
  16.     /** @var string */
  17.     private $projectDir;
  19.     /** @var array */
  20.     private $swaggerFiles;
  22.     /** @var string */
  23.     private $directory;
  25.     /** @var string */
  26.     private $assetUrlPath;
  28.     public function __construct($projectDir, $swaggerFiles, $directory, $assetUrlPath)
  29.     {
  30.         $this->projectDir = $projectDir;
  31.         $this->swaggerFiles = $swaggerFiles;
  32.         $this->directory = $directory;
  33.         $this->assetUrlPath = $assetUrlPath;
  34.     }
  36.     /**
  37.      * @param Request $request
  38.      *
  39.      * @return Response
  40.      */
  41.     public function indexAction(Request $request)
  42.     {
  43.         if (!$request->get('url')) {
  44.             // if there is no ?url=... parameter, redirect to the default one
  45.             $defaultSpecFile = reset($this->swaggerFiles);
  47.             return $this->redirect($this->getRedirectUrlToSpec($defaultSpecFile));
  48.         }
  50.         $contents = @file_get_contents(__DIR__ . '/../Resources/public/index.html');
  51.         if ($contents === false) {
  52.             throw new \RuntimeException('Unable to load [Resources/public/index.html]. Did [ScriptHandler::linkAssets] run correctly?');
  53.         }
  55.         return new Response($contents);
  56.     }
  58.     /**
  59.      * @param string $fileName
  60.      *
  61.      * @return RedirectResponse
  62.      */
  63.     public function redirectAction($fileName)
  64.     {
  65.         // redirect to swagger file if that's what we're looking for
  66.         if (in_array($fileName, $this->swaggerFiles, true)) {
  67.             return $this->redirect($this->getRedirectUrlToSpec($fileName));
  68.         }
  70.         // redirect to the assets dir so that relative links work
  71.         return $this->redirect($this->assetUrlPath . $fileName);
  72.     }
  74.     /**
  75.      * @param string $fileName
  76.      *
  77.      * @return JsonResponse|Response
  78.      */
  79.     public function swaggerFileAction($fileName)
  80.     {
  81.         try {
  82.             $filePath = $this->getFilePath($fileName);
  83.         } catch (\Exception $e) {
  84.             return new JsonResponse($e->getMessage(), Response::HTTP_NOT_FOUND);
  85.         }
  87.         $extension = strtolower(pathinfo($filePath, PATHINFO_EXTENSION));
  88.         if ($extension === 'yml' || $extension === 'yaml') {
  89.             $fileContents = Yaml::parse(file_get_contents($filePath));
  91.             return new JsonResponse($fileContents);
  92.         }
  94.         $fileContents = file_get_contents($filePath);
  96.         return new Response(
  97.             $fileContents,
  98.             Response::HTTP_OK,
  99.             ['Content-Type' => 'application/json']
  100.         );
  101.     }
  103.     /**
  104.      * @param string $fileName
  105.      *
  106.      * @return string
  107.      */
  108.     private function getFilePath($fileName = '')
  109.     {
  110.         if ($fileName !== '' && !in_array($fileName, $this->swaggerFiles)) {
  111.             throw new \RuntimeException(
  112.                 sprintf('File [%s] not defined under [hb_swagger_ui.files] in config.yml.', $fileName)
  113.             );
  114.         }
  116.         if ($this->directory === '') {
  117.             throw new \RuntimeException(
  118.                 'Directory [hb_swagger_ui.directory] not defined or empty in config.yml.'
  119.             );
  120.         }
  122.         $filePath = realpath($this->directory . DIRECTORY_SEPARATOR . $fileName);
  123.         if (!is_file($filePath)) {
  124.             throw new FileNotFoundException(sprintf('File [%s] not found.', $fileName));
  125.         }
  127.         return $filePath;
  128.     }
  130.     /**
  131.      * @param string $fileName
  132.      *
  133.      * @return string
  134.      */
  135.     private function getRedirectUrlToSpec($fileName)
  136.     {
  137.         if (strpos($fileName, '/') === 0 || preg_match('#http[s]?://#', $fileName)) {
  138.             // if absolute path or URL use it raw
  139.             $specUrl = $fileName;
  140.         } else {
  141.             $specUrl = $this->generateUrl(
  142.                 'hb_swagger_ui_swagger_file',
  143.                 ['fileName' => $fileName],
  144.                 UrlGeneratorInterface::ABSOLUTE_PATH
  145.             );
  146.         }
  148.         return $this->generateUrl('hb_swagger_ui_default', ['url' => $specUrl]);
  149.     }
  150. }