Trait

org.scalatra.swagger

SwaggerBaseBase

Related Doc: package swagger

Permalink

trait SwaggerBaseBase extends Initializable with ScalatraBase

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

Self Type
SwaggerBaseBase with JsonSupport[_] with CorsSupport
Linear Supertypes
ScalatraBase, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, Initializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerBaseBase
  2. ScalatraBase
  3. DefaultImplicitConversions
  4. LowPriorityImplicitConversions
  5. LowestPriorityImplicitConversions
  6. TypeConverterSupport
  7. ScalatraParamsImplicits
  8. DynamicScope
  9. RequestResponseScope
  10. CoreDsl
  11. Control
  12. Handler
  13. ScalatraContext
  14. CookieContext
  15. SessionSupport
  16. ServletApiImplicits
  17. Initializable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type ApiType <: SwaggerApi[_]

    Permalink
    Attributes
    protected
  2. trait Config extends AnyRef

    Permalink
    Definition Classes
    Initializable
  3. abstract type ConfigT

    Permalink
    Definition Classes
    Initializable
  4. implicit class JsonAssocNonEmpty extends AnyRef

    Permalink

Abstract Value Members

  1. implicit abstract def configWrapper(config: (SwaggerBaseBase.this)#ConfigT): (SwaggerBaseBase.this)#Config

    Permalink
    Attributes
    protected
    Definition Classes
    Initializable
  2. abstract val doNotFound: Action

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  3. abstract def docToJson(doc: (SwaggerBaseBase.this)#ApiType): JValue

    Permalink
    Attributes
    protected
  4. implicit abstract def jsonFormats: Formats

    Permalink
    Attributes
    protected
  5. abstract def requestPath(implicit request: HttpServletRequest): String

    Permalink
    Definition Classes
    ScalatraBase
  6. abstract def routeBasePath(implicit request: HttpServletRequest): String

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  7. implicit abstract def swagger: SwaggerEngine[_ <: SwaggerApi[_]]

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addRoute(method: HttpMethod, transformers: Seq[RouteTransformer], action: ⇒ Any): Route

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  5. def addSessionId(uri: String)(implicit response: HttpServletResponse): String

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  6. def addStatusRoute(codes: Range, action: ⇒ Any): Unit

    Permalink
    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase
  7. def after(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  8. implicit val anyToBoolean: TypeConverter[Any, Boolean]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  9. implicit val anyToByte: TypeConverter[Any, Byte]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  10. implicit val anyToDouble: TypeConverter[Any, Double]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  11. implicit val anyToFloat: TypeConverter[Any, Float]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  12. implicit val anyToInt: TypeConverter[Any, Int]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  13. implicit val anyToLong: TypeConverter[Any, Long]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  14. implicit val anyToShort: TypeConverter[Any, Short]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  15. implicit val anyToString: TypeConverter[Any, String]

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. def bathPath: Option[String]

    Permalink
    Attributes
    protected
  18. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  19. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. var config: (SwaggerBaseBase.this)#ConfigT

    Permalink
    Definition Classes
    ScalatraBase
  22. def contentType: String

    Permalink
    Definition Classes
    ScalatraContext
  23. def contentTypeInferrer: ContentTypeInferrer

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  24. def contentType_=(contentType: String): Unit

    Permalink
    Definition Classes
    ScalatraContext
  25. def contextPath: String

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  26. implicit def cookieOptions: CookieOptions

    Permalink
    Definition Classes
    CookieContext
  27. def cookies(implicit request: HttpServletRequest): SweetCookies

    Permalink
    Definition Classes
    CookieContext
  28. val defaultCharacterEncoding: String

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  29. implicit def defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  30. def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  31. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  32. implicit def enrichRequest(request: HttpServletRequest): RichRequest

    Permalink
    Definition Classes
    ServletApiImplicits
  33. implicit def enrichResponse(response: HttpServletResponse): RichResponse

    Permalink
    Definition Classes
    ServletApiImplicits
  34. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext

    Permalink
    Definition Classes
    ServletApiImplicits
  35. implicit def enrichSession(session: HttpSession): RichSession

    Permalink
    Definition Classes
    ServletApiImplicits
  36. def environment: String

    Permalink
    Definition Classes
    ScalatraBase
  37. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  39. def error(handler: ErrorHandler): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  40. var errorHandler: ErrorHandler

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  41. def executeRoutes(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  42. def extractStatusCode(e: HaltException): Int

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  43. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  44. def format_=(formatValue: String): Unit

    Permalink
    Definition Classes
    ScalatraContext
  45. def format_=(formatValue: Symbol): Unit

    Permalink
    Definition Classes
    ScalatraContext
  46. def fullUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Permalink
    Definition Classes
    ScalatraBase
  47. def get(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  48. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  49. def halt(result: ActionResult): Nothing

    Permalink
    Definition Classes
    Control
  50. def halt[T](status: Integer, body: T, headers: Map[String, String])(implicit arg0: Manifest[T]): Nothing

    Permalink
    Definition Classes
    Control
  51. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

    Permalink
    Definition Classes
    ScalatraBase → Handler
  52. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  53. def head(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  54. def includeFormatParameter: Boolean

    Permalink

    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
  55. def indexRoute: String

    Permalink

    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
  56. def initParameter(name: String): Option[String]

    Permalink
    Definition Classes
    ScalatraBase
  57. def initialize(config: (SwaggerBaseBase.this)#ConfigT): Unit

    Permalink
    Definition Classes
    SwaggerBaseBase → ScalatraBase → Initializable
  58. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  59. def isAsyncExecutable(result: Any): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  60. def isDevelopmentMode: Boolean

    Permalink
    Definition Classes
    ScalatraBase
  61. def isHttps(implicit request: HttpServletRequest): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  62. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  63. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): TypeConverter[Any, T]

    Permalink
    Definition Classes
    LowestPriorityImplicitConversions
  64. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  65. def multiParams(implicit request: HttpServletRequest): MultiParams

    Permalink
    Definition Classes
    ScalatraBase
  66. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]

    Permalink
    Definition Classes
    ScalatraBase
  67. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  68. def needsHttps: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  69. def notFound(fun: ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  70. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  71. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  72. def options(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  73. def params(implicit request: HttpServletRequest): Params

    Permalink
    Definition Classes
    ScalatraBase
  74. def params(key: Symbol)(implicit request: HttpServletRequest): String

    Permalink
    Definition Classes
    ScalatraBase
  75. def params(key: String)(implicit request: HttpServletRequest): String

    Permalink
    Definition Classes
    ScalatraBase
  76. def pass(): Nothing

    Permalink
    Definition Classes
    Control
  77. def patch(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  78. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  79. def post(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  80. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  81. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

    Permalink
    Definition Classes
    ScalatraBase
  82. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  83. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Permalink
    Definition Classes
    ScalatraBase
  84. def removeRoute(method: String, route: Route): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  85. def removeRoute(method: HttpMethod, route: Route): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  86. def renderHaltException(e: HaltException): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  87. def renderPipeline: RenderPipeline

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  88. def renderResponse(actionResult: Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  89. def renderResponseBody(actionResult: Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  90. def renderSwagger2(docs: List[(SwaggerBaseBase.this)#ApiType]): JValue

    Permalink
    Attributes
    protected
  91. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  92. implicit def request: HttpServletRequest

    Permalink
    Definition Classes
    DynamicScope → RequestResponseScope
  93. implicit def response: HttpServletResponse

    Permalink
    Definition Classes
    DynamicScope → RequestResponseScope
  94. lazy val routes: RouteRegistry

    Permalink
    Definition Classes
    ScalatraBase
  95. def runFilters(filters: Traversable[Route]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  96. def runRoutes(routes: Traversable[Route]): Stream[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  97. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]

    Permalink
    Definition Classes
    TypeConverterSupport
  98. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): TypeConverter[S, T]

    Permalink
    Definition Classes
    TypeConverterSupport
  99. implicit def scalatraContext: ScalatraContext

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  100. implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  101. implicit def seqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], Seq[T]]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  102. def serverHost(implicit request: HttpServletRequest): String

    Permalink
    Definition Classes
    ScalatraBase
  103. def serverPort(implicit request: HttpServletRequest): Int

    Permalink
    Definition Classes
    ScalatraBase
  104. def servletContext: ServletContext

    Permalink
    Definition Classes
    ScalatraBase → ScalatraContext
  105. def session(key: Symbol)(implicit request: HttpServletRequest): Any

    Permalink
    Definition Classes
    SessionSupport
  106. def session(key: String)(implicit request: HttpServletRequest): Any

    Permalink
    Definition Classes
    SessionSupport
  107. implicit def session(implicit request: HttpServletRequest): HttpSession

    Permalink
    Definition Classes
    SessionSupport
  108. def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]

    Permalink
    Definition Classes
    SessionSupport
  109. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  110. def shutdown(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Initializable
  111. def status: Int

    Permalink
    Definition Classes
    ScalatraContext
  112. def status_=(code: Int): Unit

    Permalink
    Definition Classes
    ScalatraContext
  113. implicit def string2RouteMatcher(path: String): RailsRouteMatcher

    Permalink
    Definition Classes
    SwaggerBaseBase → ScalatraBase
  114. implicit val stringToBoolean: TypeConverter[String, Boolean]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  115. implicit val stringToByte: TypeConverter[String, Byte]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  116. def stringToDate(format: ⇒ String): TypeConverter[String, Date]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  117. def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  118. implicit val stringToDouble: TypeConverter[String, Double]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  119. implicit val stringToFloat: TypeConverter[String, Float]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  120. implicit val stringToInt: TypeConverter[String, Int]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  121. implicit val stringToLong: TypeConverter[String, Long]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  122. implicit val stringToSelf: TypeConverter[String, String]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  123. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  124. implicit val stringToShort: TypeConverter[String, Short]

    Permalink
    Definition Classes
    DefaultImplicitConversions
  125. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  126. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  127. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams

    Permalink
    Definition Classes
    ScalatraParamsImplicits
  128. implicit def toTypedParams(params: Params): TypedParams

    Permalink
    Definition Classes
    ScalatraParamsImplicits
  129. def trap(codes: Range)(block: ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  130. def trap(code: Int)(block: ⇒ Any): Unit

    Permalink
    Definition Classes
    CoreDsl
  131. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Permalink
    Definition Classes
    ScalatraBase
  132. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

    Permalink
    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  136. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Permalink
    Attributes
    protected[org.scalatra]
    Definition Classes
    DynamicScope → RequestResponseScope
  137. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Permalink
    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  138. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S)(implicit request: HttpServletRequest): S

    Permalink
    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase

Deprecated Value Members

  1. def renderDoc(doc: (SwaggerBaseBase.this)#ApiType): JValue

    Permalink
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Swagger 1.x support will be dropped in Scalatra 2.7.0

  2. def renderIndex(docs: List[(SwaggerBaseBase.this)#ApiType]): JValue

    Permalink
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Swagger 1.x support will be dropped in Scalatra 2.7.0

Inherited from ScalatraBase

Inherited from DefaultImplicitConversions

Inherited from LowPriorityImplicitConversions

Inherited from LowestPriorityImplicitConversions

Inherited from TypeConverterSupport

Inherited from ScalatraParamsImplicits

Inherited from DynamicScope

Inherited from RequestResponseScope

Inherited from CoreDsl

Inherited from Control

Inherited from Handler

Inherited from ScalatraContext

Inherited from CookieContext

Inherited from SessionSupport

Inherited from ServletApiImplicits

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped