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
- Alphabetic
- By Inheritance
- SwaggerBase
- Initializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait Config extends AnyRef
- Definition Classes
- Initializable
- abstract type ConfigT
- Definition Classes
- Initializable
- implicit class JsonAssocNonEmpty extends AnyRef
Abstract Value Members
- implicit abstract def configWrapper(config: (SwaggerBase.this)#ConfigT): (SwaggerBase.this)#Config
- Attributes
- protected
- Definition Classes
- Initializable
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bathPath: Option[String]
- Attributes
- protected
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- implicit def docToJson(doc: Api): JValue
- Attributes
- protected
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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
- 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
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit def jsonFormats: Formats
- Attributes
- protected
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def renderSwagger2(docs: List[Api]): JValue
- Attributes
- protected
- 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
- implicit def string2RouteMatcher(path: String): RailsRouteMatcher
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)