Package org.pipservices4.swagger.controllers

Class SwaggerController

java.lang.Object
org.pipservices4.http.controllers.RestController
org.pipservices4.swagger.controllers.SwaggerController
All Implemented Interfaces:
org.pipservices4.components.config.IConfigurable, org.pipservices4.components.refer.IReferenceable, org.pipservices4.components.refer.IUnreferenceable, org.pipservices4.components.run.IClosable, org.pipservices4.components.run.IOpenable, org.pipservices4.http.controllers.IRegisterable, org.pipservices4.http.controllers.ISwaggerController
public class SwaggerController extends org.pipservices4.http.controllers.RestController implements org.pipservices4.http.controllers.ISwaggerController

  • Field Summary

    Fields inherited from class org.pipservices4.http.controllers.RestController

    _baseRoute, _config, _counters, _dependencyResolver, _endpoint, _logger, _swaggerController, _swaggerEnable, _swaggerRoute, _tracer, _url

  • Constructor Summary

    Constructors
    Constructor
    Description
    SwaggerController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    register()
     
    void
    registerOpenApiSpec(String baseRoute, String swaggerRoute)
     

    Methods inherited from class org.pipservices4.http.controllers.RestController

    close, configure, getBodyAsJson, getBodyAsString, getQueryParameter, getTraceId, instrument, isOpen, open, registerInterceptor, registerOpenApiSpec, registerOpenApiSpecFromFile, registerRoute, registerRoute, registerRouteWithAuth, sendCreatedResult, sendDeletedResult, sendEmptyResult, sendError, sendResult, setReferences, unsetReferences

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SwaggerController

      public SwaggerController()

  • Method Details

    • register

      public void register()
      Specified by:
      register in interface org.pipservices4.http.controllers.IRegisterable
      Specified by:
      register in class org.pipservices4.http.controllers.RestController

    • registerOpenApiSpec

      public void registerOpenApiSpec(String baseRoute, String swaggerRoute)
      Specified by:
      registerOpenApiSpec in interface org.pipservices4.http.controllers.ISwaggerController