com.sksamuel.scruffy.swagger

SwaggerEndpoint

Related Doc: package swagger

class SwaggerEndpoint extends HttpEndpointProvider with CorsSupport

Linear Supertypes
CorsSupport, HttpEndpointProvider, DefaultProcessors, SessionProcessors, QueryParamProcessors, HeaderProcessors, EntityProcessors, CookieProcessors, ContentTypeProcessors, ResponseConversions, ResponseBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SwaggerEndpoint
  2. CorsSupport
  3. HttpEndpointProvider
  4. DefaultProcessors
  5. SessionProcessors
  6. QueryParamProcessors
  7. HeaderProcessors
  8. EntityProcessors
  9. CookieProcessors
  10. ContentTypeProcessors
  11. ResponseConversions
  12. ResponseBuilder
  13. AnyRef
  14. 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
    ResponseConversions

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. var _errorHandler: Option[ErrorHandler]

    Definition Classes
    HttpEndpointProvider

  6. def accepted: Response

    Definition Classes
    ResponseBuilder

  7. def addHeader(name: HeaderName, v: Any)(f: ⇒ Future[Response]): Future[Response]

    Definition Classes
    HeaderProcessors

  8. def addHeader(name: String, v: Any)(f: ⇒ Future[Response]): Future[Response]

    Definition Classes
    HeaderProcessors

  9. def ajax(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    DefaultProcessors

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def badGateway: Response

    Definition Classes
    ResponseBuilder

  12. def badRequest(reason: String): Response

    Definition Classes
    ResponseBuilder

  13. def badRequest: Response

    Definition Classes
    ResponseBuilder

  14. def clone(): AnyRef

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

  15. def conflict: Response

    Definition Classes
    ResponseBuilder

  16. def consumes(mediaTypes: MediaType*)(p: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    ContentTypeProcessors

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

    Definition Classes
    ContentTypeProcessors

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

    Definition Classes
    CookieProcessors

  19. def cookieValue(name: String)(f: (String) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    CookieProcessors

  20. def created: Response

    Definition Classes
    ResponseBuilder

  21. def define(method: HttpMethod, url: String, p: (Request) ⇒ Future[Response]): HttpEndpoint

    Attributes
    protected
    Definition Classes
    HttpEndpointProvider

  22. def delete(url: String)(p: (Request) ⇒ Future[Response]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

  23. def deleteCookie(name: String)(f: ⇒ Future[Response]): Future[Response]

    Definition Classes
    CookieProcessors

  24. def emptyBody(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    EntityProcessors

  25. def entityAs[E](f: (E) ⇒ Future[Response])(implicit arg0: Manifest[E], req: Request): Future[Response]

    Definition Classes
    EntityProcessors

  26. implicit def entityFutureToResponseFuture(f: Future[Any]): Future[Response]

    Definition Classes
    ResponseConversions

  27. def entitySizeLimit(size: Int)(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    EntityProcessors

  28. implicit def entityToResponseFuture(any: Any): Future[Response]

    Definition Classes
    ResponseConversions

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

    Definition Classes
    AnyRef

  30. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  31. def errorHandler(f: ⇒ ErrorHandler): Unit

    Definition Classes
    HttpEndpointProvider

  32. implicit val executor: ExecutionContext

    Definition Classes
    HttpEndpointProvider → DefaultProcessors → ResponseConversions

  33. def expectationFailed: Response

    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): Response

    Definition Classes
    ResponseBuilder

  38. def forbidden: Response

    Definition Classes
    ResponseBuilder

  39. def found: Response

    Definition Classes
    ResponseBuilder

  40. def gatewayTimeout: Response

    Definition Classes
    ResponseBuilder

  41. def get(url: String)(p: (Request) ⇒ Future[Response]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    AnyRef → Any

  43. def gone: Response

    Definition Classes
    ResponseBuilder

  44. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  45. def head(url: String)(p: (Request) ⇒ Future[Response]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    HeaderProcessors

  47. def header(name: String, value: Any)(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    HeaderProcessors

  49. def header(name: String)(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    HeaderProcessors

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

    Definition Classes
    DefaultProcessors

  51. def http(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    DefaultProcessors

  52. val httpEndpoints: ListBuffer[HttpEndpoint]

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

  53. def https(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    DefaultProcessors

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

    Definition Classes
    DefaultProcessors

  55. def internalServerError(reason: String): Response

    Definition Classes
    ResponseBuilder

  56. def internalServerError: Response

    Definition Classes
    ResponseBuilder

  57. def internalServerError(e: Throwable): Response

    Definition Classes
    ResponseBuilder

  58. def ipAddress(regex: String)(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    DefaultProcessors

  59. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  60. def json(p: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    ContentTypeProcessors

  61. def lengthRequired: Response

    Definition Classes
    ResponseBuilder

  62. def methodNotAllowed: Response

    Definition Classes
    ResponseBuilder

  63. def movedPermanently: Response

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    AnyRef

  65. def nocontent: Response

    Definition Classes
    ResponseBuilder

  66. implicit def nodeToResponseFuture(node: Node): Future[Response]

    Definition Classes
    ResponseConversions

  67. def nonAuthoritativeInformation: Response

    Definition Classes
    ResponseBuilder

  68. def nonEmptyBody(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    EntityProcessors

  69. def notAcceptable: Response

    Definition Classes
    ResponseBuilder

  70. def notFound(body: String): Response

    Definition Classes
    ResponseBuilder

  71. def notFound: Response

    Definition Classes
    ResponseBuilder

  72. def notImplemented: Response

    Definition Classes
    ResponseBuilder

  73. def notImplemented(reason: String): Response

    Definition Classes
    ResponseBuilder

  74. def notModified: Response

    Definition Classes
    ResponseBuilder

  75. final def notify(): Unit

    Definition Classes
    AnyRef

  76. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  77. def ok(ent: Any, contentType: MediaType): Response

    Definition Classes
    ResponseBuilder

  78. def ok(ent: Any, contentType: String): Response

    Definition Classes
    ResponseBuilder

  79. def ok(e: Any): Response

    Definition Classes
    ResponseBuilder

  80. def ok: Response

    Definition Classes
    ResponseBuilder

  81. def option2response(option: Option[_]): Response

    Definition Classes
    ResponseConversions

  82. implicit def optionFutureToResponseFuture(f: Future[Option[_]]): Future[Response]

    Definition Classes
    ResponseConversions

  83. implicit def optionToResponseFuture(o: Option[_]): Future[Response]

    Definition Classes
    ResponseConversions

  84. def options(url: String)(p: (Request) ⇒ Future[Response]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

  85. def param(name: String, value: String)(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    QueryParamProcessors

  86. def param(name: String)(f: (String) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    QueryParamProcessors

  87. def partialContent: Response

    Definition Classes
    ResponseBuilder

  88. def paymentRequired: Response

    Definition Classes
    ResponseBuilder

  89. def permanentRedirect(location: String): Response

    Definition Classes
    ResponseBuilder

  90. def post(url: String)(p: (Request) ⇒ Future[Response]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

  91. def preconditionFailed: Response

    Definition Classes
    ResponseBuilder

  92. def proxyAuthenticationRequired: Response

    Definition Classes
    ResponseBuilder

  93. def put(url: String)(p: (Request) ⇒ Future[Response]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

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

    Definition Classes
    DefaultProcessors

  95. def rateLimit(limiter: RateLimiter)(f: ⇒ Future[Response]): Future[Response]

    Definition Classes
    DefaultProcessors

  96. def requestEntityTooLarge: Response

    Definition Classes
    ResponseBuilder

  97. def requestHeaderFieldsTooLarge: Response

    Definition Classes
    ResponseBuilder

  98. def requestTimeout: Response

    Definition Classes
    ResponseBuilder

  99. def requestURITooLong: Response

    Definition Classes
    ResponseBuilder

  100. def requestedRangeNotSatisfiable: Response

    Definition Classes
    ResponseBuilder

  101. def resetContent: Response

    Definition Classes
    ResponseBuilder

  102. implicit def responseToResponseFuture(resp: Response): Future[Response]

    Definition Classes
    ResponseConversions

  103. implicit def scalazValidation2responseFuture(v: ValidationNel[_, _]): Future[Response]

    Definition Classes
    ResponseConversions

  104. implicit def scalazValidationFuture2responseFuture(f: Future[ValidationNel[_, _]]): Future[Response]

    Definition Classes
    ResponseConversions

  105. def schema(f: (String) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    DefaultProcessors

  106. def seeOther(location: String): Response

    Definition Classes
    ResponseBuilder

  107. def serviceUnavailable: Response

    Definition Classes
    ResponseBuilder

  108. def session(f: (Session) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    SessionProcessors

  109. def sessionManager(manager: SessionManager)(f: (Session) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    SessionProcessors

  110. def sessionOption(f: (Option[Session]) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    SessionProcessors

  111. def sessionProperty[T](key: SessionKey[T])(f: (T) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    SessionProcessors

  112. def sessionPropertyOption[T](key: SessionKey[T])(f: (Option[T]) ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    SessionProcessors

  113. def status(s: Int): Response

    Definition Classes
    ResponseBuilder

  114. def status(s: HttpStatus): Response

    Definition Classes
    ResponseBuilder

  115. implicit def statusToResponse(s: HttpStatus): Response

    Definition Classes
    ResponseConversions

  116. implicit def statusToResponseFuture(s: HttpStatus): Future[Response]

    Definition Classes
    ResponseConversions

  117. implicit def stringFutureToResponseFuture(f: Future[String]): Future[Response]

    Definition Classes
    ResponseConversions

  118. implicit def stringToResponseFuture(str: String): Future[Response]

    Definition Classes
    ResponseConversions

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

    Definition Classes
    AnyRef

  120. def temporaryRedirect(location: String): Response

    Definition Classes
    ResponseBuilder

  121. def toString(): String

    Definition Classes
    AnyRef → Any

  122. def tooManyRequests: Response

    Definition Classes
    ResponseBuilder

  123. def trace(url: String)(p: (Request) ⇒ Future[Response]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider

  124. def try2response(t: Try[_]): Response

    Definition Classes
    ResponseConversions

  125. implicit def try2responseFuture(t: Try[_]): Future[Response]

    Definition Classes
    ResponseConversions

  126. implicit def tryFuture2responseFuture(f: Future[Try[_]]): Future[Response]

    Definition Classes
    ResponseConversions

  127. def unauthorized: Response

    Definition Classes
    ResponseBuilder

  128. def unit2response(unit: Unit): Response

    Definition Classes
    ResponseConversions

  129. implicit def unit2responseFuture(unit: Unit): Future[Response]

    Definition Classes
    ResponseConversions

  130. implicit def unitFuture2responseFuture(f: Future[Unit]): Future[Response]

    Definition Classes
    ResponseConversions

  131. def unprocessableEntity(reason: String): Response

    Definition Classes
    ResponseBuilder

  132. def unprocessableEntity: Response

    Definition Classes
    ResponseBuilder

  133. def unsupportedMediaType: Response

    Definition Classes
    ResponseBuilder

  134. def useProxy: Response

    Definition Classes
    ResponseBuilder

  135. def userAgent(regex: String)(f: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    HeaderProcessors

  136. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  139. def xml(p: ⇒ Future[Response])(implicit req: Request): Future[Response]

    Definition Classes
    ContentTypeProcessors

Inherited from CorsSupport

Inherited from HttpEndpointProvider

Inherited from DefaultProcessors

Inherited from SessionProcessors

Inherited from QueryParamProcessors

Inherited from HeaderProcessors

Inherited from EntityProcessors

Inherited from CookieProcessors

Inherited from ContentTypeProcessors

Inherited from ResponseConversions

Inherited from ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped