com.sksamuel.scruffy.swagger

SwaggerEndpoint

class SwaggerEndpoint extends HttpModule with CorsSupport

Linear Supertypes
CorsSupport, HttpModule, DefaultProcessors, SessionProcessors, QueryParamProcessors, HeaderProcessors, EntityProcessors, CookieProcessors, ContentTypeProcessors, ResponseImplicits, Processors, ResponseBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SwaggerEndpoint
  2. CorsSupport
  3. HttpModule
  4. DefaultProcessors
  5. SessionProcessors
  6. QueryParamProcessors
  7. HeaderProcessors
  8. EntityProcessors
  9. CookieProcessors
  10. ContentTypeProcessors
  11. ResponseImplicits
  12. Processors
  13. ResponseBuilder
  14. AnyRef
  15. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SwaggerEndpoint(apiVersion: String, title: String, basePath: String)

Type Members

  1. implicit class FutureOps[T] extends AnyRef

    Definition Classes
    ResponseImplicits → ResponseBuilder

  2. type Processor = (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    Processors

  3. implicit class RichAny[T] extends AnyRef

    Definition Classes
    ResponseImplicits

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. implicit def ToFutureOps[A](a: A): SwaggerEndpoint.FutureOps[A] { def self: A }

    Definition Classes
    ResponseBuilder

  7. def accepted: HttpResponse

    Definition Classes
    ResponseBuilder

  8. def add(listeners: Listener*): Unit

    Definition Classes
    HttpModule

  9. def addHeader(name: HeaderName, v: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  10. def addHeader(name: String, v: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  11. def ajax(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  13. def badGateway: HttpResponse

    Definition Classes
    ResponseBuilder

  14. def badRequest(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  15. def badRequest: HttpResponse

    Definition Classes
    ResponseBuilder

  16. implicit def byteArrayToFutureResponse(b: Array[Byte]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. def complete(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  19. def conflict: HttpResponse

    Definition Classes
    ResponseBuilder

  20. def consumes(mediaTypes: MediaType*)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  21. def contentTypeOverride(mediaType: MediaType)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  22. def cookie(name: String)(f: (Cookie) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    CookieProcessors

  23. def cookieValue(name: String)(f: (String) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    CookieProcessors

  24. def created: HttpResponse

    Definition Classes
    ResponseBuilder

  25. def define(method: HttpMethod, url: String, f: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Attributes
    protected
    Definition Classes
    HttpModule

  26. def delete(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpModule

  27. def deleteCookie(name: String)(f: ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    CookieProcessors

  28. def entityAs[E](f: (E) ⇒ (HttpRequest) ⇒ Future[HttpResponse])(implicit arg0: Manifest[E], deserializer: Deserializer[E]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    EntityProcessors

  29. def entitySizeLimit(size: Int)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    EntityProcessors

  30. def entityToResponse(x: Any): HttpResponse

    Definition Classes
    ResponseImplicits

  31. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  32. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  33. var errorHandler: Option[ErrorHandler]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  34. def errors(f: ⇒ ErrorHandler): Unit

    Definition Classes
    HttpModule

  35. implicit def exception2Response(e: Throwable): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  36. implicit val executor: ExecutionContext

    Definition Classes
    HttpModule → DefaultProcessors → ResponseImplicits

  37. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  38. def filter(filter: HttpFilter): Unit

    Definition Classes
    HttpModule

  39. var filters: ListBuffer[FilterHolder]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  40. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  41. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  42. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder

  43. def found: HttpResponse

    Definition Classes
    ResponseBuilder

  44. implicit def futureTeeToFutureResponse[T](f: Future[T])(implicit fn: (T) ⇒ HttpResponse): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  45. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  46. def get(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpModule

  47. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  48. def gone: HttpResponse

    Definition Classes
    ResponseBuilder

  49. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  50. def head(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpModule

  51. def header(name: HeaderName, value: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  52. def header(name: String, value: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  53. def header(name: HeaderName)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  54. def header(name: String)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  55. def hostname(regex: String)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  56. def http(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  57. val httpEndpoints: ListBuffer[HttpEndpoint]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  58. def https(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  59. def ifMatch(name: String)(f: ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  60. def internalServerError(entity: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  61. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  62. def internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder

  63. def internalServerError(e: Throwable): HttpResponse

    Definition Classes
    ResponseBuilder

  64. def ipAddress(f: (String) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  65. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  66. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  67. var listeners: ListBuffer[Listener]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  68. def matchesIpAddress(regex: String)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  69. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder

  70. def movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder

  71. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  72. def noEntity(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    EntityProcessors

  73. def nocontent: HttpResponse

    Definition Classes
    ResponseBuilder

  74. implicit def nodeToEndpointFn(node: Node): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  75. implicit def nodeToFuture(node: Node): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  76. implicit def nodeToResponse(node: Node): HttpResponse

    Definition Classes
    ResponseImplicits

  77. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder

  78. def notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder

  79. def notFound(f: (HttpRequest) ⇒ HttpResponse): Unit

    Definition Classes
    HttpModule

  80. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder

  81. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder

  82. var notFoundHandler: Option[(HttpRequest) ⇒ HttpResponse]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  83. def notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder

  84. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  85. def notModified: HttpResponse

    Definition Classes
    ResponseBuilder

  86. final def notify(): Unit

    Definition Classes
    AnyRef

  87. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  88. def ok(ent: Any, contentType: MediaType): HttpResponse

    Definition Classes
    ResponseBuilder

  89. def ok(ent: Any, contentType: String): HttpResponse

    Definition Classes
    ResponseBuilder

  90. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  91. def ok: HttpResponse

    Definition Classes
    ResponseBuilder

  92. implicit def optionToEndpointFn(o: Option[_]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  93. implicit def optionToEndpointFn(f: Future[Option[_]]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  94. implicit def optionToFuture(o: Option[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  95. implicit def optionToFuture(f: Future[Option[_]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  96. def options(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpModule

  97. def param(name: String, value: String)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    QueryParamProcessors

  98. def param(name: String)(f: (String) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    QueryParamProcessors

  99. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder

  100. def paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  101. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  102. def post(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpModule

  103. def preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  104. def proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  105. def put(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpModule

  106. def rateLimit(requestsPerSecond: Double, warmupPeriod: FiniteDuration)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  107. def rateLimit(limiter: RateLimiter)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  108. implicit def redirectToFutureResponse(redirect: Redirect): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  109. implicit def redirectToResponse(redirect: Redirect): HttpResponse

    Definition Classes
    ResponseImplicits

  110. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  111. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  112. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  113. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder

  114. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder

  115. def requiresEntity(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    EntityProcessors

  116. def resetContent: HttpResponse

    Definition Classes
    ResponseBuilder

  117. implicit def responseFutureToProcessor(resp: Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  118. implicit def responseToFuture(resp: HttpResponse): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  119. implicit def responseToProcessorFn(resp: HttpResponse): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  120. implicit def scalazFailureToFutureResponse(f: Future[Failure[_]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  121. implicit def scalazFailureToFutureResponse(f: Failure[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  122. implicit def scalazFailureToResponse(f: Failure[_]): HttpResponse

    Definition Classes
    ResponseImplicits

  123. implicit def scalazValToEndpointFn(v: ValidationNel[_, _]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  124. implicit def scalazValToEndpointFn(f: Future[ValidationNel[_, _]]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  125. implicit def scalazValToFutureResponse(f: Future[ValidationNel[_, _]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  126. implicit def scalazValToFutureResponse(v: ValidationNel[_, _]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  127. implicit def scalazValToResponse(f: ValidationNel[_, _]): HttpResponse

    Definition Classes
    ResponseImplicits

  128. def schema(f: (String) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  129. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  130. def serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder

  131. def session(f: (Session) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    SessionProcessors

  132. def sessionOption(f: (Option[Session]) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    SessionProcessors

  133. def sessionProperty[T](key: SessionKey[T])(f: (T) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    SessionProcessors

  134. def sessionPropertyOption[T](key: SessionKey[T])(f: (Option[T]) ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    SessionProcessors

  135. def status(s: Int, reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  136. def status(s: Int): HttpResponse

    Definition Classes
    ResponseBuilder

  137. def status(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseBuilder

  138. implicit def statusToFuture(s: HttpStatus): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  139. implicit def statusToProcessor(s: HttpStatus): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  140. implicit def statusToResponse(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseImplicits

  141. implicit def stringToFuture(str: String): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  142. implicit def stringToFuture(f: Future[String]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  143. implicit def stringToProcessor(str: String): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  144. implicit def stringToProcessor(f: Future[String]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  145. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  146. implicit def tToFuture[T](t: T): Future[T]

    Definition Classes
    ResponseImplicits

  147. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  148. def toString(): String

    Definition Classes
    AnyRef → Any

  149. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder

  150. def trace(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpModule

  151. implicit def tryToEndpointFn(t: Try[_]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  152. implicit def tryToEndpointFn(f: Future[Try[_]]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  153. implicit def tryToFuture(t: Try[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  154. implicit def tryToFuture(f: Future[Try[_]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  155. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder

  156. implicit def unitToEndpointFn(unit: Unit): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  157. implicit def unitToEndpointFn(f: Future[Unit]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  158. implicit def unitToFuture(unit: Unit): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  159. implicit def unitToFuture(f: Future[Unit]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  160. implicit def unitToResponse(unit: Unit): HttpResponse

    Definition Classes
    ResponseImplicits

  161. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  162. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder

  163. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder

  164. def useProxy: HttpResponse

    Definition Classes
    ResponseBuilder

  165. def userAgent(regex: String)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  166. def userAgent(regex: Regex)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    HeaderProcessors

  167. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  168. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  169. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CorsSupport

Inherited from HttpModule

Inherited from DefaultProcessors

Inherited from SessionProcessors

Inherited from QueryParamProcessors

Inherited from HeaderProcessors

Inherited from EntityProcessors

Inherited from CookieProcessors

Inherited from ContentTypeProcessors

Inherited from ResponseImplicits

Inherited from Processors

Inherited from ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped