t

org.scalatra.swagger

SwaggerBase

trait SwaggerBase extends Initializable

Trait that serves the resource and operation listings, as specified by the Swagger specification.

Self Type
SwaggerBase with ScalatraBase with JsonSupport[_] with CorsSupport
Linear Supertypes
Initializable, AnyRef, Any
Known Subclasses
JacksonSwaggerBase, NativeSwaggerBase
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerBase
  2. Initializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef
    Definition Classes
    Initializable
  2. abstract type ConfigT
    Definition Classes
    Initializable
  3. implicit class JsonAssocNonEmpty extends AnyRef

Abstract Value Members

  1. implicit abstract def configWrapper(config: (SwaggerBase.this)#ConfigT): (SwaggerBase.this)#Config
    Attributes
    protected
    Definition Classes
    Initializable
  2. implicit abstract def swagger: SwaggerEngine

    Returns the Swagger instance responsible for generating the resource and operation listings.

    Returns the Swagger instance responsible for generating the resource and operation listings.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def bathPath: Option[String]
    Attributes
    protected
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. implicit def docToJson(doc: Api): JValue
    Attributes
    protected
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def includeFormatParameter: Boolean

    Whether to include the format parameter in the index listing for swagger defaults to false, the format parameter will not be present but is still optional.

    Whether to include the format parameter in the index listing for swagger defaults to false, the format parameter will not be present but is still optional.

    returns

    true if the format parameter should be included in the returned json

    Attributes
    protected
  14. def indexRoute: String

    The name of the route to use when getting the index listing for swagger defaults to optional resources.:format or /

    The name of the route to use when getting the index listing for swagger defaults to optional resources.:format or /

    returns

    The name of the route

    Attributes
    protected
  15. def initialize(config: (SwaggerBase.this)#ConfigT): Unit

    A hook to initialize the class with some configuration after it has been constructed.

    A hook to initialize the class with some configuration after it has been constructed.

    Not called init because GenericServlet doesn't override it, and then we get into https://lampsvn.epfl.ch/trac/scala/ticket/2497.

    Definition Classes
    SwaggerBase → Initializable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. implicit def jsonFormats: Formats
    Attributes
    protected
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def renderSwagger2(docs: List[Api]): JValue
    Attributes
    protected
  22. def shutdown(): Unit

    A hook to shutdown the class.

    A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.

    Attributes
    protected
    Definition Classes
    Initializable
  23. implicit def string2RouteMatcher(path: String): RailsRouteMatcher
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped