com.sksamuel.scruffy.swagger

SwaggerEndpoint

Related Doc: package swagger

class SwaggerEndpoint extends HttpModule with CorsSupport

Linear Supertypes
CorsSupport, HttpModule, DefaultProcessors, SessionProcessors, PathProcessors, 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. PathProcessors
  7. QueryParamProcessors
  8. HeaderProcessors
  9. EntityProcessors
  10. CookieProcessors
  11. ContentTypeProcessors
  12. ResponseImplicits
  13. Processors
  14. ResponseBuilder
  15. AnyRef
  16. 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[A] extends AnyRef

    Definition Classes
    ResponseBuilder

  2. type Processor = (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    Processors

  3. implicit class RichFuture[T] extends AnyRef

    Definition Classes
    ResponseImplicits

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. val accepted: HttpResponse

    Definition Classes
    ResponseBuilder

  5. def add(listeners: Listener*): Unit

    Definition Classes
    HttpModule

  6. def addHeader(name: String, v: String)(f: Processor)(implicit executor: ExecutionContext): Processor

    Definition Classes
    HeaderProcessors

  7. def addHeader(key: HeaderKey, v: String)(f: Processor)(implicit executor: ExecutionContext): Processor

    Definition Classes
    HeaderProcessors

  8. def ajax(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. val badGateway: HttpResponse

    Definition Classes
    ResponseBuilder

  11. def badRequest(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  12. val badRequest: HttpResponse

    Definition Classes
    ResponseBuilder

  13. implicit def byteArrayToFutureResponse(b: Array[Byte]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  14. def clone(): AnyRef

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

  15. def complete(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  16. val conflict: HttpResponse

    Definition Classes
    ResponseBuilder

  17. def consumes(mediaTypes: MediaType*)(f: Processor): Processor

    Definition Classes
    ContentTypeProcessors

  18. def contentTypeOverride(mediaType: MediaType)(f: Processor): Processor

    Definition Classes
    ContentTypeProcessors

  19. def cookie(name: String)(f: (Cookie) ⇒ Processor): Processor

    Definition Classes
    CookieProcessors

  20. def cookieValue(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    CookieProcessors

  21. val created: HttpResponse

    Definition Classes
    ResponseBuilder

  22. def define(method: HttpMethod, url: String, f: Processor): HttpEndpoint

    Attributes
    protected
    Definition Classes
    HttpModule

  23. def delete(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  24. def deleteCookie(name: String)(f: ⇒ Processor)(implicit executor: ExecutionContext): Processor

    Definition Classes
    CookieProcessors

  25. def entity(f: (Array[Byte]) ⇒ Processor): Processor

    Definition Classes
    EntityProcessors

  26. def entityAs[E](f: (E) ⇒ Processor)(implicit manifest: Manifest[E], deserializer: Deserializer[E]): Processor

    Definition Classes
    EntityProcessors

  27. def entitySizeLimit(size: Int)(f: Processor): Processor

    Definition Classes
    EntityProcessors

  28. def entityToResponse(x: Any): HttpResponse

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    AnyRef

  30. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  31. var errorHandler: Option[ErrorHandler]

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

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

    Definition Classes
    HttpModule

  33. implicit def exception2Response(e: Throwable): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  34. val expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  35. def filter(filter: HttpFilter): SwaggerEndpoint.this.type

    Definition Classes
    HttpModule

  36. var filters: ListBuffer[FilterHolder]

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

  37. def finalize(): Unit

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

  38. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  39. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder

  40. val found: HttpResponse

    Definition Classes
    ResponseBuilder

  41. implicit def futureTeeToFutureResponse[T](f: Future[T])(implicit fn: (T) ⇒ HttpResponse, executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  42. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  43. def get(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

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

    Definition Classes
    AnyRef → Any

  45. val gone: HttpResponse

    Definition Classes
    ResponseBuilder

  46. def hasHeader(name: HeaderName, value: Any)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  47. def hasHeader(name: String, value: Any)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  48. def hasHeader(name: HeaderName)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  49. def hasHeader(name: String)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  50. def hasQueryParam(name: String, value: String)(f: Processor): Processor

    Definition Classes
    QueryParamProcessors

  51. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  52. def head(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  53. def header(name: HeaderName)(f: (String) ⇒ Processor): Processor

    Definition Classes
    HeaderProcessors

  54. def header(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    HeaderProcessors

  55. def hostname(regex: String)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  56. def http(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  57. val httpEndpoints: ListBuffer[HttpEndpoint]

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

  58. def https(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  59. def ifMatch(name: String)(f: ⇒ Processor): Processor

    Definition Classes
    HeaderProcessors

  60. def internalServerError(entity: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  61. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  62. def internalServerError(e: Throwable): HttpResponse

    Definition Classes
    ResponseBuilder

  63. val internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder

  64. def ipAddress(f: (String) ⇒ Processor): Processor

    Definition Classes
    DefaultProcessors

  65. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  66. def json[T](future: Future[T])(implicit serializer: Serializer[T], executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  67. def json[T](option: Option[T])(implicit serializer: Serializer[T]): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  68. def json[T](t: T)(implicit serializer: Serializer[T]): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  69. val lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  70. var listeners: ListBuffer[Listener]

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

  71. def marshall(mediaType: MediaType)(f: Processor)(implicit serializer: Serializer[Any], executor: ExecutionContext): Processor

    Definition Classes
    ContentTypeProcessors

  72. def matchesIpAddress(regex: String)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  73. val methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder

  74. val movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    AnyRef

  76. def noEntity(f: Processor): Processor

    Definition Classes
    EntityProcessors

  77. val nocontent: HttpResponse

    Definition Classes
    ResponseBuilder

  78. implicit def nodeToEndpointFn(node: Node): Processor

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  81. val nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder

  82. val notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder

  83. def notFound(f: NotFoundHandler): Unit

    Definition Classes
    HttpModule

  84. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder

  85. val notFound: HttpResponse

    Definition Classes
    ResponseBuilder

  86. var notFoundHandler: Option[NotFoundHandler]

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

  87. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  88. val notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder

  89. val notModified: HttpResponse

    Definition Classes
    ResponseBuilder

  90. final def notify(): Unit

    Definition Classes
    AnyRef

  91. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    ResponseBuilder

  94. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  95. val ok: HttpResponse

    Definition Classes
    ResponseBuilder

  96. implicit def optionToEndpointFn(o: Option[_]): Processor

    Definition Classes
    ResponseImplicits

  97. implicit def optionToEndpointFn(f: Future[Option[_]])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  99. implicit def optionToFuture(f: Future[Option[_]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  100. def options(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  101. val partialContent: HttpResponse

    Definition Classes
    ResponseBuilder

  102. def pathParam(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    PathProcessors

  103. val paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  104. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  105. def post(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  106. def postfilter(fn: (HttpResponse) ⇒ HttpResponse)(implicit executor: ExecutionContext): SwaggerEndpoint.this.type

    Definition Classes
    HttpModule

  107. val preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  108. def prefilter(fn: (HttpRequest) ⇒ HttpRequest): SwaggerEndpoint.this.type

    Definition Classes
    HttpModule

  109. val proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  110. def put(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  111. def queryParam(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  112. def queryParam(name: String, default: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  113. def queryParamBoolean(name: String, default: Boolean)(f: (Boolean) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  114. def queryParamBoolean(name: String)(f: (Boolean) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  115. def queryParamDouble(name: String, default: Double)(f: (Double) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  116. def queryParamDouble(name: String)(f: (Double) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  117. def queryParamInt(name: String, default: Int)(f: (Int) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  118. def queryParamInt(name: String)(f: (Int) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  119. def queryParamLong(name: String, default: Long)(f: (Long) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  120. def queryParamLong(name: String)(f: (Long) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  121. def queryParamOpt(name: String)(f: (Option[String]) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  122. def queryParams(name: String)(f: (Seq[String]) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  123. def rateLimit(requestsPerSecond: Double, warmupPeriod: FiniteDuration)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  124. def rateLimit(limiter: RateLimiter)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  125. implicit def redirectToFutureResponse(redirect: Redirect): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  126. implicit def redirectToResponse(redirect: Redirect): HttpResponse

    Definition Classes
    ResponseImplicits

  127. val requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  128. val requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  129. val requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  130. val requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder

  131. val requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder

  132. def requiresEntity(f: Processor): Processor

    Definition Classes
    EntityProcessors

  133. val resetContent: HttpResponse

    Definition Classes
    ResponseBuilder

  134. implicit def responseFutureToProcessor(resp: Future[HttpResponse]): Processor

    Definition Classes
    ResponseImplicits

  135. implicit def responseToFuture(resp: HttpResponse): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  136. implicit def responseToProcessorFn(resp: HttpResponse): Processor

    Definition Classes
    ResponseImplicits

  137. implicit def scalazFailureToFutureResponse(f: Future[Failure[_]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  138. implicit def scalazFailureToFutureResponse(f: Failure[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  139. implicit def scalazFailureToResponse(f: Failure[_]): HttpResponse

    Definition Classes
    ResponseImplicits

  140. implicit def scalazValToEndpointFn(v: ValidationNel[_, _])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  141. implicit def scalazValToEndpointFn(f: Future[ValidationNel[_, _]])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  142. implicit def scalazValToFutureResponse(f: Future[ValidationNel[_, _]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  143. implicit def scalazValToFutureResponse(v: ValidationNel[_, _]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  144. implicit def scalazValToResponse(f: ValidationNel[_, _]): HttpResponse

    Definition Classes
    ResponseImplicits

  145. def schema(f: (String) ⇒ Processor): Processor

    Definition Classes
    DefaultProcessors

  146. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  147. val serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder

  148. def session(f: (Session) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  149. def sessionOption(f: (Option[Session]) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  150. def sessionProperty[T](key: SessionKey[T])(f: (T) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  151. def sessionPropertyOption[T](key: SessionKey[T])(f: (Option[T]) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  152. def status(s: Int, reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  153. def status(s: Int): HttpResponse

    Definition Classes
    ResponseBuilder

  154. def status(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseBuilder

  155. implicit def statusToFuture(s: HttpStatus): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  156. implicit def statusToProcessor(s: HttpStatus): Processor

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  158. implicit def stringToFuture(str: String): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  159. implicit def stringToFuture(f: Future[String])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  160. implicit def stringToProcessor(str: String): Processor

    Definition Classes
    ResponseImplicits

  161. implicit def stringToProcessor(f: Future[String])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    AnyRef

  163. implicit def tToFuture[T](t: T): Future[T]

    Definition Classes
    ResponseImplicits

  164. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  165. def toString(): String

    Definition Classes
    AnyRef → Any

  166. val tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder

  167. def trace(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  168. implicit def tryToEndpointFn(t: Try[_])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  169. implicit def tryToEndpointFn(f: Future[Try[_]])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  170. implicit def tryToFuture(t: Try[_])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  171. implicit def tryToFuture(f: Future[Try[_]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  172. val unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder

  173. implicit def unitToEndpointFn(unit: Unit): Processor

    Definition Classes
    ResponseImplicits

  174. implicit def unitToEndpointFn(f: Future[Unit])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  176. implicit def unitToFuture(f: Future[Unit])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    ResponseImplicits

  178. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  179. val unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder

  180. val unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder

  181. val useProxy: HttpResponse

    Definition Classes
    ResponseBuilder

  182. def userAgent(regex: String)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  183. def userAgent(regex: Regex)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  184. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def hasParam(name: String, value: String)(f: Processor): Processor

    Definition Classes
    QueryParamProcessors
    Annotations
    @deprecated
    Deprecated

    (Since version 1.13.3) prefer hasQueryParam

  2. def param(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors
    Annotations
    @deprecated
    Deprecated

    (Since version 1.13.3) prefer queryParam

Inherited from CorsSupport

Inherited from HttpModule

Inherited from DefaultProcessors

Inherited from SessionProcessors

Inherited from PathProcessors

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