org.scalatra.swagger

SwaggerSupport

trait SwaggerSupport extends ScalatraSyntax with SwaggerSupportBase with SwaggerSupportSyntax

Provides the necessary support for adding documentation to your routes.

Linear Supertypes
SwaggerSupportSyntax, CorsSupport, SwaggerSupportBase, ScalatraSyntax, DefaultImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, Initializable, RequestResponseScope, CoreDsl, ServletApiImplicits, Control, Handler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SwaggerSupport
  2. SwaggerSupportSyntax
  3. CorsSupport
  4. SwaggerSupportBase
  5. ScalatraSyntax
  6. DefaultImplicitConversions
  7. TypeConverterSupport
  8. ScalatraParamsImplicits
  9. Initializable
  10. RequestResponseScope
  11. CoreDsl
  12. ServletApiImplicits
  13. Control
  14. Handler
  15. AnyRef
  16. 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 addSessionId(uri: String): String

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  2. abstract def applicationDescription: String

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  3. abstract def config: ConfigT

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  4. implicit abstract def configWrapper(config: ConfigT): Config

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  6. implicit abstract def request: HttpServletRequest

    Definition Classes
    RequestResponseScope
  7. abstract def requestPath: String

    Definition Classes
    ScalatraSyntax
  8. implicit abstract def response: HttpServletResponse

    Definition Classes
    RequestResponseScope
  9. abstract def routeBasePath: String

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  10. implicit abstract def swagger: SwaggerEngine[_]

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  11. abstract def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

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

    Attributes
    protected
    Definition Classes
    RequestResponseScope
  13. abstract def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    RequestResponseScope

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. val _params: Params

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  7. def addRoute(method: HttpMethod, transformers: Seq[(Route) ⇒ Route], action: ⇒ Any): Route

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

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  10. def applicationName: Option[String]

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

    Definition Classes
    Any
  12. def augmentSimpleRequest(): Unit

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  14. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  16. def contentType: String

    Definition Classes
    CoreDsl
  17. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  18. def contentType_=(contentType: String): Unit

    Definition Classes
    CoreDsl
  19. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  20. implicit def dataType2string(dt: DataType): String

    Definition Classes
    SwaggerSupportSyntax
  21. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  22. def delete(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

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

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  25. def endpoint(value: String): (Route) ⇒ Route

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

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

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

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

    Definition Classes
    ServletApiImplicits
  31. def environment: String

    Definition Classes
    ScalatraSyntax
  32. final def eq(arg0: AnyRef): Boolean

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

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  35. var errorHandler: ErrorHandler

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  36. def errors(value: Error*): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  37. def executeRoutes(): Unit

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  38. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  39. def fullUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean): String

    Definition Classes
    ScalatraSyntax
  40. def get(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraSyntax → CoreDsl
  41. final def getClass(): Class[_]

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  47. def initParameter(name: String): Option[String]

    Definition Classes
    ScalatraSyntax
  48. 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
  49. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  50. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  51. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraSyntax
  52. def isHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  53. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  55. implicit def modelToSwagger(cls: Class[_]): (String, Model)

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  56. def models: Map[String, Model]

    Definition Classes
    SwaggerSupportSyntax
  57. def models_=(m: Map[String, Model]): Unit

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  58. def multiParams: MultiParams

    Definition Classes
    ScalatraSyntax → CoreDsl
  59. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  60. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  61. def nickname(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  62. def notFound(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraSyntax → CoreDsl
  63. def notes(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  64. final def notify(): Unit

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

    Definition Classes
    AnyRef
  66. def operations(route: Route, method: HttpMethod): List[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
  67. def options(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraSyntax → CoreDsl
  68. def parameters(value: Parameter*): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  69. def params: Params

    Definition Classes
    ScalatraSyntax → CoreDsl
  70. def pass(): Nothing

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  72. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

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

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  75. def redirect(uri: String): Unit

    Definition Classes
    ScalatraSyntax → CoreDsl
  76. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  77. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean): String

    Definition Classes
    ScalatraSyntax
  78. def removeRoute(method: String, route: Route): Unit

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  80. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  81. def renderPipeline: RenderPipeline

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  82. def renderResponse(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  83. def renderResponseBody(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  84. def responseClass[T](implicit mf: Manifest[T]): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  85. def responseClass(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  86. lazy val routes: RouteRegistry

    Definition Classes
    ScalatraSyntax
  87. def runFilters(filters: Traversable[Route]): Unit

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

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

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

    Definition Classes
    TypeConverterSupport
  91. implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

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

    Definition Classes
    DefaultImplicitConversions
  93. def serverHost: String

    Definition Classes
    ScalatraSyntax
  94. def serverPort: Int

    Definition Classes
    ScalatraSyntax
  95. def servletContext: ServletContext

    Definition Classes
    ScalatraSyntax → CoreDsl
  96. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable
  97. def status: Int

    Definition Classes
    CoreDsl
  98. def status_=(code: Int): Unit

    Definition Classes
    CoreDsl
  99. implicit def string2RouteMatcher(path: String): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  100. implicit val stringToBoolean: TypeConverter[String, Boolean]

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

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

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

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

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

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

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

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

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

    Definition Classes
    DefaultImplicitConversions
  110. implicit val stringToSeqBoolean: TypeConverter[String, Seq[Boolean]]

    Definition Classes
    DefaultImplicitConversions
  111. implicit val stringToSeqByte: TypeConverter[String, Seq[Byte]]

    Definition Classes
    DefaultImplicitConversions
  112. implicit val stringToSeqDouble: TypeConverter[String, Seq[Double]]

    Definition Classes
    DefaultImplicitConversions
  113. implicit val stringToSeqFloat: TypeConverter[String, Seq[Float]]

    Definition Classes
    DefaultImplicitConversions
  114. implicit val stringToSeqInt: TypeConverter[String, Seq[Int]]

    Definition Classes
    DefaultImplicitConversions
  115. implicit val stringToSeqLong: TypeConverter[String, Seq[Long]]

    Definition Classes
    DefaultImplicitConversions
  116. implicit val stringToSeqShort: TypeConverter[String, Seq[Short]]

    Definition Classes
    DefaultImplicitConversions
  117. implicit val stringToSeqString: TypeConverter[String, Seq[String]]

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

    Definition Classes
    DefaultImplicitConversions
  119. def summary(value: String): (Route) ⇒ Route

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  120. def swaggerDefaultErrors: List[Error]

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

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

    Definition Classes
    AnyRef
  123. def toString(): String

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

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

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

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

    Definition Classes
    CoreDsl
  128. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean): String

    Definition Classes
    ScalatraSyntax
  129. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  132. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    Definition Classes
    ScalatraSyntax

Deprecated Value Members

  1. def applicationContext: ServletContext

    Definition Classes
    CoreDsl
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use servletContext instead

  2. def status(code: Int): Unit

    Definition Classes
    CoreDsl
    Annotations
    @deprecated
    Deprecated

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

Inherited from SwaggerSupportSyntax

Inherited from CorsSupport

Inherited from SwaggerSupportBase

Inherited from ScalatraSyntax

Inherited from DefaultImplicitConversions

Inherited from TypeConverterSupport

Inherited from ScalatraParamsImplicits

Inherited from Initializable

Inherited from RequestResponseScope

Inherited from CoreDsl

Inherited from ServletApiImplicits

Inherited from Control

Inherited from Handler

Inherited from AnyRef

Inherited from Any

Ungrouped