com.sksamuel.scruffy.swagger

SwaggerEndpoint

Related Doc: package swagger

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

  2. trait HttpResponseOps[A] extends AnyRef

    Definition Classes
    ResponseBuilder

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. implicit def ToFutureOps[A](a: A): SwaggerEndpoint.FutureOps[A] { def self: A }

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseBuilder

  6. def accepted: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    DefaultProcessors

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def badGateway: HttpResponse

    Definition Classes
    ResponseBuilder

  10. def badRequest(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  11. def badRequest: HttpResponse

    Definition Classes
    ResponseBuilder

  12. def clone(): AnyRef

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

  13. def conflict: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ContentTypeProcessors

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

    Definition Classes
    ContentTypeProcessors

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

    Definition Classes
    CookieProcessors

  17. def created: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    EntityProcessors

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

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseBuilder

  23. def entity(ent: Any): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    EntityProcessors

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    EntityProcessors

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

    Definition Classes
    AnyRef

  28. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  29. implicit val executor: ExecutionContextExecutor

    Definition Classes
    SwaggerEndpoint → DefaultProcessors → HttpResponseImplicits

  30. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  31. def filter(filter: Filter): Unit

    Definition Classes
    HttpEndpointProvider

  32. var filters: ListBuffer[FilterHolder]

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

  33. def finalize(): Unit

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

  34. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  35. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder

  36. def found: HttpResponse

    Definition Classes
    ResponseBuilder

  37. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    AnyRef → Any

  40. def gone: HttpResponse

    Definition Classes
    ResponseBuilder

  41. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  49. val httpEndpoints: ListBuffer[HttpEndpoint]

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

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  52. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  53. def internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    DefaultProcessors

  55. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    ContentTypeProcessors

  57. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  58. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder

  59. def movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    AnyRef

  61. def nocontent: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

  63. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    EntityProcessors

  65. def notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder

  66. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder

  67. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder

  68. def notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder

  69. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  70. def notModified: HttpResponse

    Definition Classes
    ResponseBuilder

  71. final def notify(): Unit

    Definition Classes
    AnyRef

  72. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  73. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  74. def ok: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    ParamProcessors

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

    Definition Classes
    ParamProcessors

  81. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder

  82. def paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  83. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

  85. def preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  86. def proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  90. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  91. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  92. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  93. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder

  94. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder

  95. def resetContent: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

  99. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  100. def serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    SessionProcessors

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

    Definition Classes
    SessionProcessors

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

    Definition Classes
    SessionProcessors

  104. def static(url: String): StaticEndpointBuilder

    Definition Classes
    StaticEndpointProvider

  105. val staticEndpoints: ListBuffer[StaticEndpointBuilder]

    Definition Classes
    StaticEndpointProvider

  106. def status(s: Int): HttpResponse

    Definition Classes
    ResponseBuilder

  107. def status(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    AnyRef

  113. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  114. def toString(): String

    Definition Classes
    AnyRef → Any

  115. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

  120. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder

  121. def unit2response(unit: Unit): HttpResponse

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

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

    Definition Classes
    HttpResponseImplicits

  124. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  125. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder

  126. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder

  127. def useProxy: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    HeaderProcessors

  129. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    WebsocketEndpointProvider

  133. val websocketEndpoints: ListBuffer[WebsocketEndpoint]

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

  134. 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