org.scalatra.swagger

NativeSwaggerBase

trait NativeSwaggerBase extends ScalatraSyntax with NativeJsonSupport with CorsSupport with SwaggerBase

Linear Supertypes
SwaggerBase, SwaggerBaseBase, CorsSupport, NativeJsonSupport, JValueResult, NativeJsonOutput, JsonMethods, JsonSupport[Document], JsonOutput[Document], JsonMethods[Document], ApiFormats, ScalatraSyntax, DefaultImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, Initializable, RequestResponseScope, CoreDsl, ServletApiImplicits, Control, Handler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NativeSwaggerBase
  2. SwaggerBase
  3. SwaggerBaseBase
  4. CorsSupport
  5. NativeJsonSupport
  6. JValueResult
  7. NativeJsonOutput
  8. JsonMethods
  9. JsonSupport
  10. JsonOutput
  11. JsonMethods
  12. ApiFormats
  13. ScalatraSyntax
  14. DefaultImplicitConversions
  15. TypeConverterSupport
  16. ScalatraParamsImplicits
  17. Initializable
  18. RequestResponseScope
  19. CoreDsl
  20. ServletApiImplicits
  21. Control
  22. Handler
  23. AnyRef
  24. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type ApiType = Api

    Definition Classes
    SwaggerBaseSwaggerBaseBase
  2. trait Config extends AnyRef

    Definition Classes
    Initializable
  3. abstract type ConfigT

    Definition Classes
    Initializable
  4. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits
  5. 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 config: ConfigT

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

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  5. implicit abstract def jsonFormats: Formats

    Attributes
    protected
    Definition Classes
    JValueResult
  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[ApiType]

    Returns the Swagger instance responsible for generating the resource and operation listings.

    Returns the Swagger instance responsible for generating the resource and operation listings.

    Attributes
    protected
    Definition Classes
    SwaggerBaseSwaggerBaseBase
  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 acceptHeader: List[String]

    Definition Classes
    ApiFormats
  8. def acceptedFormats(accepted: Symbol*): Boolean

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

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

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def augmentSimpleRequest(): Unit

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

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  16. def cacheRequestBodyAsString: Boolean

    Attributes
    protected
    Definition Classes
    JsonSupport
  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def compact(d: Document): String

    Definition Classes
    JsonMethods → JsonMethods
  19. def contentType: String

    Definition Classes
    CoreDsl
  20. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ApiFormats → ScalatraSyntax
  21. def contentType_=(contentType: String): Unit

    Definition Classes
    CoreDsl
  22. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  23. def defaultAcceptedFormats: List[Symbol]

    Definition Classes
    ApiFormats
  24. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  25. def defaultFormat: Symbol

    Definition Classes
    ApiFormats
  26. def delete(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraSyntax → CoreDsl
  27. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  28. def docToJson(doc: Api): JValue

    Attributes
    protected
    Definition Classes
    SwaggerBaseSwaggerBaseBase
  29. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

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

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

    Definition Classes
    ServletApiImplicits
  33. def environment: String

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

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

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  37. var errorHandler: ErrorHandler

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

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

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

    Definition Classes
    ApiFormats
  41. def formatForMimeTypes(mimeTypes: String*): Option[String]

    Attributes
    protected
    Definition Classes
    ApiFormats
  42. def format_=(formatValue: String): Unit

    Definition Classes
    ApiFormats
  43. def format_=(formatValue: Symbol): Unit

    Definition Classes
    ApiFormats
  44. val formats: Map[String, String]

    Definition Classes
    ApiFormats
  45. def fullUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean): String

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

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

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  53. def inferFromFormats: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ApiFormats
  54. def initParameter(name: String): Option[String]

    Definition Classes
    ScalatraSyntax
  55. def initialize(config: ConfigT): Unit

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

    Attributes
    protected
    Definition Classes
    JsonSupport → ScalatraSyntax
  57. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  58. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraSyntax
  59. def isHttps: Boolean

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

    Definition Classes
    Any
  61. lazy val jsonVulnerabilityGuard: Boolean

    Attributes
    protected
    Definition Classes
    JsonOutput
  62. def jsonpCallbackParameterNames: Iterable[String]

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  64. val mimeTypes: Map[String, String]

    Definition Classes
    ApiFormats
  65. def multiParams: MultiParams

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

    Definition Classes
    AnyRef
  67. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  68. def notFound(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraSyntax → CoreDsl
  69. final def notify(): Unit

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

    Definition Classes
    AnyRef
  71. def options(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraSyntax → CoreDsl
  72. def params: Params

    Definition Classes
    ScalatraSyntax → CoreDsl
  73. def parse(in: JsonInput, useBigDecimalForDouble: Boolean): JValue

    Definition Classes
    JsonMethods → JsonMethods
  74. def parseOpt(in: JsonInput, useBigDecimalForDouble: Boolean): Option[JValue]

    Definition Classes
    JsonMethods → JsonMethods
  75. def parseRequestBody(format: String): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  76. def parsedBody: JValue

    Definition Classes
    JsonSupport
  77. def pass(): Nothing

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

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

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

    Definition Classes
    ScalatraSyntax → CoreDsl
  81. def pretty(d: Document): String

    Definition Classes
    JsonMethods → JsonMethods
  82. def put(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraSyntax → CoreDsl
  83. def readJsonFromBody(bd: String): JValue

    Attributes
    protected
    Definition Classes
    NativeJsonSupport → JsonSupport
  84. def readJsonFromStream(stream: InputStream): JValue

    Attributes
    protected
    Definition Classes
    NativeJsonSupport → JsonSupport
  85. def readXmlFromBody(bd: String): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  86. def readXmlFromStream(stream: InputStream): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  87. def redirect(uri: String): Unit

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

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

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

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  92. def render(value: JValue): Document

    Definition Classes
    JsonMethods → JsonMethods
  93. def renderDoc(doc: ApiType): JValue

    Attributes
    protected
    Definition Classes
    SwaggerBaseBase
  94. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  95. def renderIndex(docs: List[ApiType]): JValue

    Attributes
    protected
    Definition Classes
    SwaggerBaseBase
  96. def renderPipeline: RenderPipeline

    Attributes
    protected
    Definition Classes
    JValueResult → ScalatraSyntax
  97. def renderResponse(actionResult: Any): Unit

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  99. def responseFormat: String

    Definition Classes
    ApiFormats
  100. lazy val routes: RouteRegistry

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

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

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

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

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

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

    Definition Classes
    DefaultImplicitConversions
  107. def serverHost: String

    Definition Classes
    ScalatraSyntax
  108. def serverPort: Int

    Definition Classes
    ScalatraSyntax
  109. def servletContext: ServletContext

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

    Attributes
    protected
    Definition Classes
    Initializable
  111. def status: Int

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  134. def toString(): String

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

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

    Definition Classes
    ScalatraParamsImplicits
  137. def transformRequestBody(body: JValue): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  138. def transformResponseBody(body: JValue): JValue

    Attributes
    protected
    Definition Classes
    JsonOutput
  139. def trap(codes: Range)(block: ⇒ Any): Unit

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    ScalatraSyntax
  146. def writeJson(json: JValue, writer: Writer): Unit

    Attributes
    protected
    Definition Classes
    NativeJsonOutput → JsonOutput
  147. def writeJsonAsXml(json: JValue, writer: Writer): Unit

    Attributes
    protected
    Definition Classes
    JsonOutput
  148. lazy val xmlRootNode: Elem

    Attributes
    protected
    Definition Classes
    JsonOutput

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 SwaggerBase

Inherited from SwaggerBaseBase

Inherited from CorsSupport

Inherited from NativeJsonSupport

Inherited from JValueResult

Inherited from NativeJsonOutput

Inherited from JsonMethods

Inherited from JsonSupport[Document]

Inherited from JsonOutput[Document]

Inherited from JsonMethods[Document]

Inherited from ApiFormats

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