com.sksamuel.scruffy.swagger

SwaggerEndpoint

class SwaggerEndpoint extends EndpointProvider with CorsSupport

Linear Supertypes
CorsSupport, EndpointProvider, StaticEndpointProvider, WebsocketEndpointProvider, HttpEndpointProvider, DefaultProcessors, SessionProcessors, ParamProcessors, HeaderProcessors, EntityProcessors, CookieProcessors, ContentTypeProcessors, 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. HeaderProcessors
  11. EntityProcessors
  12. CookieProcessors
  13. ContentTypeProcessors
  14. HttpResponseImplicits
  15. ResponseBuilder
  16. AnyRef
  17. 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
    HttpResponseImplicits → 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): SwaggerEndpoint.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*)(p: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  17. def contentTypeOverride(mediaType: MediaType)(p: (HttpRequest) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

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

    Definition Classes
    CookieProcessors

  19. def created: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    HttpEndpointProvider

  22. implicit val ec: ExecutionContextExecutor

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    EntityProcessors

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

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseBuilder

  26. def entity(ent: Any): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    EntityProcessors

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    EntityProcessors

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

    Definition Classes
    AnyRef

  31. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  32. implicit val executor: ExecutionContext

    Definition Classes
    HttpResponseImplicits

  33. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  34. def filter(filter: Filter): Unit

    Definition Classes
    HttpEndpointProvider

  35. var filters: ListBuffer[FilterHolder]

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

  36. def finalize(): Unit

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

  37. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  38. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder

  39. def found: HttpResponse

    Definition Classes
    ResponseBuilder

  40. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    AnyRef → Any

  43. def gone: HttpResponse

    Definition Classes
    ResponseBuilder

  44. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  52. val httpEndpoints: ListBuffer[HttpEndpoint]

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

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  55. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  56. def internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    DefaultProcessors

  58. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    ContentTypeProcessors

  60. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  61. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder

  62. def movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    AnyRef

  64. def nocontent: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

  66. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    EntityProcessors

  68. def notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder

  69. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder

  70. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder

  71. def notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder

  72. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  73. def notModified: HttpResponse

    Definition Classes
    ResponseBuilder

  74. final def notify(): Unit

    Definition Classes
    AnyRef

  75. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  76. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  77. def ok: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    ParamProcessors

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

    Definition Classes
    ParamProcessors

  84. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder

  85. def paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  86. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

  88. def preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  89. def proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  93. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  94. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  95. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  96. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder

  97. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder

  98. def resetContent: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

  102. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  103. def serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder

  104. def session(f: (Session) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    SessionProcessors

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

    Definition Classes
    SessionProcessors

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

    Definition Classes
    SessionProcessors

  107. def static(url: String): StaticEndpointBuilder

    Definition Classes
    StaticEndpointProvider

  108. val staticEndpoints: ListBuffer[StaticEndpointBuilder]

    Definition Classes
    StaticEndpointProvider

  109. def status(s: Int): HttpResponse

    Definition Classes
    ResponseBuilder

  110. def status(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    AnyRef

  116. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  117. def toString(): String

    Definition Classes
    AnyRef → Any

  118. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

  123. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder

  124. def unit2response(unit: Unit): HttpResponse

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

  127. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  128. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder

  129. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder

  130. def useProxy: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HeaderProcessors

  132. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    WebsocketEndpointProvider

  136. val websocketEndpoints: ListBuffer[WebsocketEndpoint]

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

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

    Definition Classes
    ContentTypeProcessors

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 HeaderProcessors

Inherited from EntityProcessors

Inherited from CookieProcessors

Inherited from ContentTypeProcessors

Inherited from HttpResponseImplicits

Inherited from ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped