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, 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. DefaultImplicitConversions
  7. LowPriorityImplicitConversions
  8. LowestPriorityImplicitConversions
  9. TypeConverterSupport
  10. ScalatraParamsImplicits
  11. Initializable
  12. DynamicScope
  13. RequestResponseScope
  14. CoreDsl
  15. Control
  16. Handler
  17. ScalatraContext
  18. CookieContext
  19. SessionSupport
  20. ServletApiImplicits
  21. AnyRef
  22. 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[RouteTransformer], 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: RouteTransformer*)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  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], arg1: NotNothing[T]): OperationBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSwaggerSupportSyntax
  20. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  21. def augmentSimpleRequest(): Unit

    Attributes
    protected
    Definition Classes
    CorsSupport
  22. def before(transformers: RouteTransformer*)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  23. def bodyParam(name: String, model: Model): ModelParameterBuilder

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

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

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  26. def bodyParam[T](implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]

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

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

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

    Definition Classes
    ScalatraBase
  30. def contentType: String

    Definition Classes
    ScalatraContext
  31. def contentTypeInferrer: ContentTypeInferrer

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

    Definition Classes
    ScalatraContext
  33. def contextPath: String

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

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

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

    Definition Classes
    SwaggerSupportSyntax
  37. val defaultCharacterEncoding: String

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

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  40. def description(f: PartialFunction[String, String]): Unit

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  42. def endpoint(value: String): RouteTransformer

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  43. 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
  44. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

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

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

    Definition Classes
    ServletApiImplicits
  48. def environment: String

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

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

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  52. var errorHandler: ErrorHandler

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  54. 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
  55. def extractStatusCode(e: HaltException): Int

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  57. def formParam(name: String, model: Model): ModelParameterBuilder

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  58. def formParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  59. def format_=(formatValue: String): Unit

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

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

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  63. final def getClass(): Class[_]

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

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

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

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

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

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  70. def headerParam(name: String, model: Model): ModelParameterBuilder

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

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

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

    Definition Classes
    ScalatraBase
  74. 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
  75. def invoke(matchedRoute: MatchedRoute): Option[Any]

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  77. def isDevelopmentMode: Boolean

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

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

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

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  82. 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
  83. def multiParams(implicit request: HttpServletRequest): MultiParams

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

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

    Definition Classes
    AnyRef
  86. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  87. def notFound(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  88. final def notify(): Unit

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

    Definition Classes
    AnyRef
  90. def operation(op: SwaggerOperation): RouteTransformer

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

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  93. implicit def parameterBuilder2parameter(pmb: SwaggerParameterBuilder): Parameter

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

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

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

    Definition Classes
    ScalatraBase
  97. def pass(): Nothing

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  99. def pathParam(name: String, model: Model): ModelParameterBuilder

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

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

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

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  103. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  104. def queryParam(name: String, model: Model): ModelParameterBuilder

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

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  108. def registerModel[T]()(implicit arg0: Manifest[T], arg1: NotNothing[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
  109. 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
  110. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

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

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  114. def renderPipeline: RenderPipeline

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  117. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

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

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

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

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

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

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

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

    Definition Classes
    TypeConverterSupport
  125. implicit def scalatraContext: ScalatraContext

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

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

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

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

    Definition Classes
    ScalatraBase
  130. def servletContext: ServletContext

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Initializable
  137. def status: Int

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    DefaultImplicitConversions
  151. def swaggerAuthorizations: List[String]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  152. def swaggerConsumes: List[String]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  153. def swaggerDefaultMessages: List[ResponseMessage[_]]

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

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  155. def swaggerMeta(s: Symbol, v: Any): RouteTransformer

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  156. def swaggerProduces: List[String]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  157. def swaggerProtocols: List[String]

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

    Definition Classes
    AnyRef
  159. def toString(): String

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

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

    Definition Classes
    ScalatraParamsImplicits
  162. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  163. def trap(codes: Range)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  164. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

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

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

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

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

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

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

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

    Attributes
    protected[org.scalatra]
    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 applicationName: Option[String]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.1) This field is no longer used, due to changes in Swagger spec 1.2

  5. def errors(value: Error*): RouteTransformer

    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

  6. 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

  7. 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

  8. def nickname(value: String): RouteTransformer

    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

  9. def notes(value: String): RouteTransformer

    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

  10. def parameters(value: Parameter*): RouteTransformer

    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

  11. def responseClass[T](implicit mf: Manifest[T]): RouteTransformer

    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

  12. def responseClass(value: String): RouteTransformer

    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

  13. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

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

  14. def summary(value: String): RouteTransformer

    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

  15. def swaggerDefaultErrors: List[ResponseMessage[_]]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.2) Swagger spec 1.2 renamed this to swaggerDefaultMessages, please use that one

Inherited from SwaggerSupportSyntax

Inherited from CorsSupport

Inherited from SwaggerSupportBase

Inherited from ScalatraBase

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