You are here

interface SwaggerUiLibraryDiscoveryInterface in Swagger UI Field Formatter 8.3

Generic definition of a Swagger UI library discovery service.

Hierarchy

Expanded class hierarchy of SwaggerUiLibraryDiscoveryInterface

All classes that implement SwaggerUiLibraryDiscoveryInterface

1 file declares its use of SwaggerUiLibraryDiscoveryInterface
SwaggerUiLibraryDiscovery.php in tests/modules/swagger_ui_formatter_test/src/Service/SwaggerUiLibraryDiscovery.php

File

src/Service/SwaggerUiLibraryDiscoveryInterface.php, line 10

Namespace

Drupal\swagger_ui_formatter\Service
View source
interface SwaggerUiLibraryDiscoveryInterface {

  /**
   * Gets the Swagger UI library directory.
   *
   * This is a relative path from the DRUPAL_ROOT. No leading slash should be
   * included in the returned path.
   *
   * @return string
   *   The path of the Swagger UI library directory relative to DRUPAL_ROOT.
   *
   * @throws \Drupal\swagger_ui_formatter\Exception\SwaggerUiLibraryDiscoveryExceptionInterface
   */
  public function libraryDirectory() : string;

  /**
   * Gets the Swagger UI library version.
   *
   * @return string
   *   The Swagger UI library version.
   *
   * @throws \Drupal\swagger_ui_formatter\Exception\SwaggerUiLibraryDiscoveryExceptionInterface
   */
  public function libraryVersion() : string;

}

Members

Namesort descending Modifiers Type Description Overrides
SwaggerUiLibraryDiscoveryInterface::libraryDirectory public function Gets the Swagger UI library directory. 2
SwaggerUiLibraryDiscoveryInterface::libraryVersion public function Gets the Swagger UI library version. 2