Docs.php

Go to the documentation of this file.

<?php
 
declare(strict_types = 1);
 
namespace Drupal\dkan_api\Controller;
 
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Serialization\Yaml;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\RequestStack;
 
class Docs implements ContainerInjectionInterface {
 
  private $spec;
 
  private $moduleHandler;
 
  private $requestStack;
 
  private $serializer;
 
  public static function create(ContainerInterface $container) {
    return new Docs(
      $container->get('module_handler'),
      $container->get('request_stack')
    );
  }
 
  public function __construct(
    ModuleHandlerInterface $moduleHandler,
    RequestStack $requestStack
  ) {
    $this->moduleHandler = $moduleHandler;
    $this->requestStack = $requestStack;
    $this->serializer = new Yaml();
    $this->spec = $this->getJsonFromYmlFile();
  }
 
  public function getVersions() {
    return new JsonResponse(["version" => 1, "url" => "/api/1"]);
  }
 
  public function getJsonFromYmlFile() {
    $modulePath = $this->moduleHandler->getModule('dkan_api')->getPath();
    $ymlSpecPath = $modulePath . '/docs/dkan_api_openapi_spec.yml';
    $ymlSpec = file_get_contents($ymlSpecPath);
 
    return $this->serializer->decode($ymlSpec);
  }
 
  public function getComplete() {
    if ($this->requestStack->getCurrentRequest()->get('authentication') === "false") {
      $spec = $this->getPublic();
    }
    else {
      $spec = $this->spec;
    }
 
    $jsonSpec = json_encode($spec);
    return $this->sendResponse($jsonSpec);
  }
 
  private function getPublic() {
    $publicSpec = $this->removeAuthenticatedEndpoints($this->spec);
    $cleanSpec = $this->cleanUpEndpoints($publicSpec);
    unset($cleanSpec['components']['securitySchemes']);
    return $cleanSpec;
  }
 
  private function removeAuthenticatedEndpoints(array $spec) {
    foreach ($spec['paths'] as $path => $operations) {
      $this->removeAuthenticatedOperations($operations, $path, $spec);
    }
    return $spec;
  }
 
  private function removeAuthenticatedOperations(array $operations, string $path, array &$spec) {
    foreach ($operations as $operation => $details) {
      if (isset($spec['paths'][$path][$operation]['security'])) {
        unset($spec['paths'][$path][$operation]);
      }
    }
  }
 
  private function cleanUpEndpoints(array $spec) {
    foreach ($spec['paths'] as $path => $operations) {
      if (empty($operations)) {
        unset($spec['paths'][$path]);
      }
    }
    return $spec;
  }
 
  private function sendResponse(string $jsonSpec) {
    return new JsonResponse(
              $jsonSpec,
              200,
              [
                'Content-type' => 'application/json',
                'Access-Control-Allow-Origin' => '*',
              ],
              TRUE
          );
  }
 
}