com.sksamuel.scruffy.swagger

SwaggerEndpoint

class SwaggerEndpoint extends EndpointProvider with CorsSupport

Linear Supertypes
CorsSupport, EndpointProvider, StaticEndpointProvider, WebsocketEndpointProvider, HttpEndpointProvider, DefaultProcessors, SessionProcessors, ParamProcessors, HttpResponseImplicits, ResponseBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SwaggerEndpoint
  2. CorsSupport
  3. EndpointProvider
  4. StaticEndpointProvider
  5. WebsocketEndpointProvider
  6. HttpEndpointProvider
  7. DefaultProcessors
  8. SessionProcessors
  9. ParamProcessors
  10. HttpResponseImplicits
  11. ResponseBuilder
  12. AnyRef
  13. 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. trait FutureOps[A] extends AnyRef

    Definition Classes
    ResponseBuilder

  2. trait HttpResponseOps[A] extends AnyRef

    Definition Classes
    ResponseBuilder

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): FutureOps[A] { def self: A }

    Definition Classes
    ResponseBuilder

  7. implicit def ToHttpResponseOps[A](a: A): HttpResponseOps[A] { def self: A }

    Definition Classes
    ResponseBuilder

  8. def accepted: HttpResponse

    Definition Classes
    ResponseBuilder

  9. def ajax(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def badGateway: HttpResponse

    Definition Classes
    ResponseBuilder

  12. def badRequest(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  13. def badRequest: HttpResponse

    Definition Classes
    ResponseBuilder

  14. def clone(): AnyRef

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

  15. def conflict: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  18. def created: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

  20. def delete2(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

  21. implicit val ec: ExecutionContextExecutor

    Definition Classes
    DefaultProcessors

  22. def emptyBody(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  23. def entity(ent: Any, contentType: MediaType): HttpResponse

    Definition Classes
    ResponseBuilder

  24. def entity(ent: Any, contentType: String): HttpResponse

    Definition Classes
    ResponseBuilder

  25. def entity(ent: Any): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    DefaultProcessors

  27. implicit def entityFutureToResponseFuture(f: Future[Any]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    AnyRef

  30. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  31. implicit val executor: ExecutionContext

    Definition Classes
    HttpResponseImplicits

  32. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  33. def filter(filter: Filter): Unit

    Definition Classes
    HttpEndpointProvider

  34. var filters: ListBuffer[FilterHolder]

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

  35. def finalize(): Unit

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

  36. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  37. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder

  38. def found: HttpResponse

    Definition Classes
    ResponseBuilder

  39. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  40. def get2(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    AnyRef → Any

  42. def gone: HttpResponse

    Definition Classes
    ResponseBuilder

  43. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  47. def header(name: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  48. def header(name: HeaderName)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  49. def hostname(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  50. def http(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  51. val httpEndpoints: ListBuffer[HttpEndpoint]

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

  52. def https(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  53. def ifMatch(name: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  54. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  55. def internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder

  56. def ipAddress(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  57. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  58. def json(any: Any): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  59. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  60. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder

  61. def movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    AnyRef

  63. def nocontent: HttpResponse

    Definition Classes
    ResponseBuilder

  64. implicit def nodeToResponseFuture(node: Node): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  65. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder

  66. def nonEmptyBody(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  67. def notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder

  68. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder

  69. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder

  70. def notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder

  71. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  72. def notModified: HttpResponse

    Definition Classes
    ResponseBuilder

  73. final def notify(): Unit

    Definition Classes
    AnyRef

  74. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  75. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  76. def ok: HttpResponse

    Definition Classes
    ResponseBuilder

  77. def option2response(option: Option[_]): HttpResponse

    Definition Classes
    HttpResponseImplicits

  78. implicit def optionFutureToResponseFuture(f: Future[Option[_]]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  79. implicit def optionToResponseFuture(o: Option[_]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  80. def options2(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    ParamProcessors

  82. def param(name: String)(f: (String) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    ParamProcessors

  83. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder

  84. def paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  85. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  86. def post2(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

  87. def preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  88. def proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  89. def put2(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  92. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  93. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  94. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  95. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder

  96. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder

  97. def resetContent: HttpResponse

    Definition Classes
    ResponseBuilder

  98. implicit def responseToResponseFuture(resp: HttpResponse): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  99. implicit def scalazValidation2responseFuture(v: ValidationNel[_, _]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  100. implicit def scalazValidationFuture2responseFuture(f: Future[ValidationNel[_, _]]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  101. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  102. def serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder

  103. def sessionManager(manager: SessionManager)(f: (Session) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    SessionProcessors

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

    Definition Classes
    SessionProcessors

  105. def static(url: String): StaticEndpointBuilder

    Definition Classes
    StaticEndpointProvider

  106. val staticEndpoints: ListBuffer[StaticEndpointBuilder]

    Definition Classes
    StaticEndpointProvider

  107. def status(s: Int): HttpResponse

    Definition Classes
    ResponseBuilder

  108. def status(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

  110. implicit def statusToResponseFuture(s: HttpStatus): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  111. implicit def stringFutureToResponseFuture(f: Future[String]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  112. implicit def stringToResponseFuture(str: String): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    AnyRef

  114. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  115. def toString(): String

    Definition Classes
    AnyRef → Any

  116. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder

  117. def trace2(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

  118. def try2response(t: Try[_]): HttpResponse

    Definition Classes
    HttpResponseImplicits

  119. implicit def try2responseFuture(t: Try[_]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  120. implicit def tryFuture2responseFuture(f: Future[Try[_]]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  121. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder

  122. def unit2response(unit: Unit): HttpResponse

    Definition Classes
    HttpResponseImplicits

  123. implicit def unit2responseFuture(unit: Unit): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  124. implicit def unitFuture2responseFuture(f: Future[Unit]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits

  125. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  126. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder

  127. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder

  128. def useProxy: HttpResponse

    Definition Classes
    ResponseBuilder

  129. def userAgent(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

  130. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  133. def websocket(path: String)(f: ⇒ WebsocketHandler): Unit

    Definition Classes
    WebsocketEndpointProvider

  134. val websocketEndpoints: ListBuffer[WebsocketEndpoint]

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

  135. def xml(any: Any): Future[HttpResponse]

    Definition Classes
    DefaultProcessors

Inherited from CorsSupport

Inherited from EndpointProvider

Inherited from StaticEndpointProvider

Inherited from WebsocketEndpointProvider

Inherited from HttpEndpointProvider

Inherited from DefaultProcessors

Inherited from SessionProcessors

Inherited from ParamProcessors

Inherited from HttpResponseImplicits

Inherited from ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped