org.scalatra.swagger

SwaggerSupport

trait SwaggerSupport extends ScalatraBase with SwaggerSupportBase with SwaggerSupportSyntax

Provides the necessary support for adding documentation to your routes.

Linear Supertypes
SwaggerSupportSyntax, CorsSupport, SwaggerSupportBase, ScalatraBase, CookieSupport, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, Initializable, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SwaggerSupport
  2. SwaggerSupportSyntax
  3. CorsSupport
  4. SwaggerSupportBase
  5. ScalatraBase
  6. CookieSupport
  7. DefaultImplicitConversions
  8. LowPriorityImplicitConversions
  9. LowestPriorityImplicitConversions
  10. TypeConverterSupport
  11. ScalatraParamsImplicits
  12. Initializable
  13. DynamicScope
  14. RequestResponseScope
  15. CoreDsl
  16. Control
  17. Handler
  18. ScalatraContext
  19. CookieContext
  20. SessionSupport
  21. ServletApiImplicits
  22. AnyRef
  23. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef

    Definition Classes
    Initializable
  2. abstract type ConfigT

    Definition Classes
    Initializable
  3. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits
  4. sealed class TypedParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

Abstract Value Members

  1. abstract def applicationDescription: String

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  2. implicit abstract def configWrapper(config: ConfigT): Config

    Attributes
    protected
    Definition Classes
    Initializable
  3. abstract val doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase
  4. abstract def requestPath(implicit request: HttpServletRequest): String

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  6. implicit abstract def swagger: SwaggerEngine[_]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addRoute(method: HttpMethod, transformers: Seq[(Route) ⇒ Route], action: ⇒ Any): Route

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    LowPriorityImplicitConversions
  18. def apiOperation(nickname: String, model: Model): OperationBuilder

    Attributes
    protected
  19. def apiOperation[T](nickname: String)(implicit arg0: Manifest[T]): OperationBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSwaggerSupportSyntax
  20. def applicationName: Option[String]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  21. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  22. def augmentSimpleRequest(): Unit

    Attributes
    protected
    Definition Classes
    CorsSupport
  23. def before(transformers: (Route) ⇒ Route*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  24. def bodyParam(name: String, model: Model): ModelParameterBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  25. def bodyParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  26. def bodyParam(model: Model): ModelParameterBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  27. def bodyParam[T](implicit arg0: Manifest[T]): ParameterBuilder[T]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  28. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. var config: ConfigT

    Definition Classes
    ScalatraBase
  31. def contentType: String

    Definition Classes
    ScalatraContext
  32. def contentTypeInferrer: ContentTypeInferrer

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

    Definition Classes
    ScalatraContext
  34. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  35. implicit def cookieOptions: CookieOptions

    Definition Classes
    CookieContext
  36. def cookies: SweetCookies

    Definition Classes
    CookieContext
  37. implicit def dataType2string(dt: DataType): String

    Definition Classes
    SwaggerSupportSyntax
  38. val defaultCharacterEncoding: String

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

    Definition Classes
    DefaultImplicitConversions
  40. def delete(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  41. def description(f: PartialFunction[String, String]): Unit

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  42. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase
  43. def endpoint(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  44. def endpoints(basePath: String): List[Endpoint]

    Builds the documentation for all the endpoints discovered in an API.

    Builds the documentation for all the endpoints discovered in an API.

    Definition Classes
    SwaggerSupportSwaggerSupportBase
  45. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

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

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

    Definition Classes
    ServletApiImplicits
  49. def environment: String

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

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

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

    Definition Classes
    ScalatraBase → CoreDsl
  53. var errorHandler: ErrorHandler

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  55. def extractOperation(route: Route, method: HttpMethod): Operation

    Returns a list of operations based on the given route.

    Returns a list of operations based on the given route. The default implementation returns a list with only 1 operation.

    Attributes
    protected
    Definition Classes
    SwaggerSupportSwaggerSupportBase
  56. def finalize(): Unit

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

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

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

    Definition Classes
    ScalatraBase
  60. def get(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

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

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

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

    Definition Classes
    Control
  64. def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

    Definition Classes
    CorsSupport → Handler
  65. def handlePreflightRequest(): Unit

    Attributes
    protected
    Definition Classes
    CorsSupport
  66. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  67. def headerParam(name: String, model: Model): ModelParameterBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  68. def headerParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  69. def inferSwaggerEndpoint(route: Route): String

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  70. def initParameter(name: String): Option[String]

    Definition Classes
    ScalatraBase
  71. def initialize(config: ConfigT): Unit

    Initializes the kernel.

    Initializes the kernel. Used to provide context that is unavailable when the instance is constructed, for example the servlet lifecycle. Should set the config variable to the parameter.

    config

    the configuration.

    Definition Classes
    SwaggerSupportSyntax → CorsSupport → Initializable
  72. def invoke(matchedRoute: MatchedRoute): Option[Any]

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  74. def isDevelopmentMode: Boolean

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

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

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

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

    Definition Classes
    ScalatraBase → CoreDsl
  79. def models: Map[String, Model]

    The currently registered model descriptions for swagger

    The currently registered model descriptions for swagger

    returns

    a map of swagger models

    Definition Classes
    SwaggerSupportSyntax
  80. def multiParams(implicit request: HttpServletRequest): MultiParams

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

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

    Definition Classes
    AnyRef
  83. def needsHttps: Boolean

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

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

    Definition Classes
    AnyRef
  86. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  87. def operation(op: SwaggerOperation): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  88. implicit def operationBuilder2operation[T](bldr: SwaggerOperationBuilder[Operation]): Operation

    Attributes
    protected
  89. def options(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  90. implicit def parameterBuilder2parameter(pmb: SwaggerParameterBuilder): Parameter

    Definition Classes
    SwaggerSupportSyntax
  91. def params(implicit request: HttpServletRequest): Params

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

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

    Definition Classes
    ScalatraBase
  94. def pass(): Nothing

    Definition Classes
    Control
  95. def patch(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  96. def pathParam(name: String, model: Model): ModelParameterBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  97. def pathParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  98. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

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

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

    Definition Classes
    ScalatraBase → CoreDsl
  101. def queryParam(name: String, model: Model): ModelParameterBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  102. def queryParam[T](name: String)(implicit arg0: Manifest[T]): ParameterBuilder[T]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  103. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  105. def registerModel[T]()(implicit arg0: Manifest[T]): Unit

    Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion

    Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion

    T

    the class of the model to register

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  106. def registerModel(model: Model): Unit

    Registers a model for swagger

    Registers a model for swagger

    model

    the model to add to the swagger definition

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

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

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  111. def renderPipeline: RenderPipeline

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  114. implicit def request: HttpServletRequest

    Definition Classes
    DynamicScope → RequestResponseScope
  115. implicit def response: HttpServletResponse

    Definition Classes
    DynamicScope → RequestResponseScope
  116. lazy val routes: RouteRegistry

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

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

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

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

    Definition Classes
    TypeConverterSupport
  121. implicit def scalatraContext: ScalatraContext

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

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

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

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

    Definition Classes
    ScalatraBase
  126. def servletContext: ServletContext

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Initializable
  133. def status: Int

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

    Definition Classes
    ScalatraContext
  135. implicit def string2RouteMatcher(path: String): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  136. implicit val stringToBoolean: TypeConverter[String, Boolean]

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    DefaultImplicitConversions
  147. def swaggerDefaultErrors: List[Error]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  148. def swaggerDefaultProduces: List[String]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  149. def swaggerEndpointEntries[T <: SwaggerOperation](extract: (Route, HttpMethod) ⇒ T): Iterable[Entry[T]]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  150. def swaggerMeta(s: Symbol, v: Any): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  151. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  152. def toString(): String

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

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

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

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

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

    Definition Classes
    ScalatraBase
  158. final def wait(): Unit

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  164. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    Definition Classes
    ScalatraBase

Deprecated Value Members

  1. def _request: DynamicVariable[HttpServletRequest]

    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withRequest to change the binding, or request to get the value

  2. def _response: DynamicVariable[HttpServletResponse]

    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withResponse to change the binding, or response to get the value

  3. def applicationContext: ServletContext

    Definition Classes
    ScalatraBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use servletContext instead

  4. def errors(value: Error*): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.errors and operation methods to build swagger descriptions of endpoints

  5. implicit def modelToSwagger(cls: Class[_]): (String, Model)

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) This implicit conversion will be removed in the future

  6. def models_=(m: Map[String, Model]): Map[String, Model]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use registerModel[T] or registerModel(model) instead, this method will be removed in the future

  7. def nickname(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.nickname and operation methods to build swagger descriptions of endpoints

  8. def notes(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.notes and operation methods to build swagger descriptions of endpoints

  9. def parameters(value: Parameter*): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.parameters and operation methods to build swagger descriptions of endpoints

  10. def responseClass[T](implicit mf: Manifest[T]): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.responseClass and operation methods to build swagger descriptions of endpoints

  11. def responseClass(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the variant where you use a type parameter, this method doesn't allow for reflection and requires you to manually ad the model

  12. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use status_=(Int) instead

  13. def summary(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.summary and operation methods to build swagger descriptions of endpoints

Inherited from SwaggerSupportSyntax

Inherited from CorsSupport

Inherited from SwaggerSupportBase

Inherited from ScalatraBase

Inherited from CookieSupport

Inherited from DefaultImplicitConversions

Inherited from LowPriorityImplicitConversions

Inherited from LowestPriorityImplicitConversions

Inherited from TypeConverterSupport

Inherited from ScalatraParamsImplicits

Inherited from Initializable

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 AnyRef

Inherited from Any

Ungrouped