Trait

org.scalatra.swagger

SwaggerSupport

Related Doc: package swagger

Permalink

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
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef

    Permalink
    Definition Classes
    Initializable
  2. abstract type ConfigT

    Permalink
    Definition Classes
    Initializable
  3. sealed class TypedMultiParams extends AnyRef

    Permalink
    Definition Classes
    ScalatraParamsImplicits
  4. sealed class TypedParams extends AnyRef

    Permalink
    Definition Classes
    ScalatraParamsImplicits

Abstract Value Members

  1. abstract def applicationDescription: String

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax

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. def apiOperation(nickname: String, model: Model): OperationBuilder

    Permalink
    Attributes
    protected
  17. def apiOperation[T](nickname: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): OperationBuilder

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

    Permalink
    Definition Classes
    Any
  19. def augmentSimpleRequest(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    CorsSupport
  20. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ScalatraBase
  28. def contentType: String

    Permalink
    Definition Classes
    ScalatraContext
  29. def contentTypeInferrer: ContentTypeInferrer

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

    Permalink
    Definition Classes
    ScalatraContext
  31. def contextPath: String

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

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

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

    Permalink
    Definition Classes
    SwaggerSupportSyntax
  35. val defaultCharacterEncoding: String

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

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

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

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

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

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

    Permalink

    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
  42. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

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

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

    Permalink
    Definition Classes
    ServletApiImplicits
  46. def environment: String

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

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

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

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

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

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

    Permalink

    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
  53. def extractStatusCode(e: HaltException): Int

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  68. def headerParam(name: String, model: Model): ModelParameterBuilder

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

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

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

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

    Permalink

    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
  73. def invoke(matchedRoute: MatchedRoute): Option[Any]

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

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

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

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

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

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

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

    Permalink

    The currently registered model descriptions for swagger

    The currently registered model descriptions for swagger

    returns

    a map of swagger models

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

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

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

    Permalink
    Definition Classes
    AnyRef
  84. def needsHttps: Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  106. def registerModel[T]()(implicit arg0: Manifest[T], arg1: NotNothing[T]): Unit

    Permalink

    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
  107. def registerModel(model: Model): Unit

    Permalink

    Registers a model for swagger

    Registers a model for swagger

    model

    the model to add to the swagger definition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    TypeConverterSupport
  123. implicit def scalatraContext: ScalatraContext

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

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

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

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

    Permalink
    Definition Classes
    ScalatraBase
  128. def servletContext: ServletContext

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    DefaultImplicitConversions
  149. def swaggerAuthorizations: List[String]

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    CoreDsl
  162. 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
  163. final def wait(): Unit

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  169. 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 _request: DynamicVariable[HttpServletRequest]

    Permalink
    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]

    Permalink
    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

    Permalink
    Definition Classes
    ScalatraBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use servletContext instead

  4. def applicationName: Option[String]

    Permalink
    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

    Permalink
    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)

    Permalink
    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]

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    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

    Permalink
    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

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

  14. def summary(value: String): RouteTransformer

    Permalink
    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[_]]

    Permalink
    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