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

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: HttpListener*): 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. def clone(): AnyRef

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

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

    Definition Classes
    DefaultProcessors

  18. def conflict: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ContentTypeProcessors

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

    Definition Classes
    ContentTypeProcessors

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

    Definition Classes
    CookieProcessors

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

    Definition Classes
    CookieProcessors

  23. def created: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Attributes
    protected
    Definition Classes
    HttpModule

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

    Definition Classes
    HttpModule

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

    Definition Classes
    CookieProcessors

  27. def entityAs[E](f: (E) ⇒ (HttpRequest) ⇒ Future[HttpResponse])(implicit arg0: Manifest[E]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    EntityProcessors

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

    Definition Classes
    EntityProcessors

  29. def entityToResponse(x: Any): HttpResponse

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    AnyRef

  31. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  32. var errorHandler: Option[ErrorHandler]

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

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

    Definition Classes
    HttpModule

  34. implicit val executor: ExecutionContext

    Definition Classes
    HttpModule → DefaultProcessors → ResponseImplicits

  35. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  36. def filter(filter: HttpFilter): Unit

    Definition Classes
    HttpModule

  37. var filters: ListBuffer[FilterHolder]

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

  38. def finalize(): Unit

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

  39. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  40. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder

  41. def found: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseImplicits

  43. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpModule

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

    Definition Classes
    AnyRef → Any

  46. def gone: HttpResponse

    Definition Classes
    ResponseBuilder

  47. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    HttpModule

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  55. val httpEndpoints: ListBuffer[HttpEndpoint]

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

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    HeaderProcessors

  58. def internalServerError(entity: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  59. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  60. def internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder

  61. def internalServerError(e: Throwable): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    DefaultProcessors

  63. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    ContentTypeProcessors

  65. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  66. var listeners: ListBuffer[HttpListener]

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

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

    Definition Classes
    DefaultProcessors

  68. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder

  69. def movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    AnyRef

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

    Definition Classes
    EntityProcessors

  72. def nocontent: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  76. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder

  77. def notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpModule

  79. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder

  80. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder

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

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

  82. def notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder

  83. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  84. def notModified: HttpResponse

    Definition Classes
    ResponseBuilder

  85. final def notify(): Unit

    Definition Classes
    AnyRef

  86. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseBuilder

  89. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  90. def ok: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    HttpModule

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

    Definition Classes
    QueryParamProcessors

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

    Definition Classes
    QueryParamProcessors

  98. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder

  99. def paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  100. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpModule

  102. def preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  103. implicit def productToFuture(prod: Product): Future[Product]

    Definition Classes
    ResponseImplicits

  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 statusToEndpointFn(s: HttpStatus): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  139. implicit def statusToFuture(s: HttpStatus): 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. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  147. def toString(): String

    Definition Classes
    AnyRef → Any

  148. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpModule

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  154. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  160. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  161. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder

  162. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder

  163. def useProxy: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

  166. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  169. def xml(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

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