com
.
sksamuel
.
scruffy
.
swagger
SwaggerEndpoint
class
SwaggerEndpoint
extends
EndpointProvider
with
CorsSupport
Linear Supertypes
CorsSupport
,
EndpointProvider
,
StaticEndpointProvider
,
WebsocketResourceProvider
,
HttpEndpointProvider
,
ResponseBuilder
,
AnyRef
,
Any
Ordering
Alphabetic
By inheritance
Inherited
SwaggerEndpoint
CorsSupport
EndpointProvider
StaticEndpointProvider
WebsocketResourceProvider
HttpEndpointProvider
ResponseBuilder
AnyRef
Any
Hide All
Show all
Learn more about member selection
Visibility
Public
All
Instance Constructors
new
SwaggerEndpoint
(
apiVersion:
String
,
title:
String
,
basePath:
String
)
Value Members
final
def
!=
(
arg0:
Any
)
:
Boolean
Definition Classes
AnyRef → Any
final
def
##
()
:
Int
Definition Classes
AnyRef → Any
final
def
==
(
arg0:
Any
)
:
Boolean
Definition Classes
AnyRef → Any
def
accepted
:
HttpResponse
Definition Classes
ResponseBuilder
def
after
(
processor:
Processor
)
:
Unit
Definition Classes
HttpEndpointProvider
var
afters
:
ListBuffer
[
Processor
]
Attributes
protected[
com.sksamuel.scruffy
]
Definition Classes
HttpEndpointProvider
implicit
def
any2future
(
any:
Any
)
:
Future
[
HttpResponse
]
Definition Classes
ResponseBuilder
implicit
def
any2response
(
any:
Any
)
:
HttpResponse
Definition Classes
ResponseBuilder
final
def
asInstanceOf
[
T0
]
:
T0
Definition Classes
Any
def
badGateway
:
HttpResponse
Definition Classes
ResponseBuilder
def
badRequest
(
reason:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
badRequest
:
HttpResponse
Definition Classes
ResponseBuilder
def
before
(
processor:
Processor
)
:
Unit
Definition Classes
HttpEndpointProvider
var
befores
:
ListBuffer
[
Processor
]
Attributes
protected[
com.sksamuel.scruffy
]
Definition Classes
HttpEndpointProvider
val
builders
:
ListBuffer
[
HttpEndpointBuilder
[_, _]]
Attributes
protected[
com.sksamuel.scruffy
]
Definition Classes
HttpEndpointProvider
def
clone
()
:
AnyRef
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
...
)
def
conflict
:
HttpResponse
Definition Classes
ResponseBuilder
def
created
:
HttpResponse
Definition Classes
ResponseBuilder
def
delete
(
url:
String
)
:
HttpEndpointBuilder
[
Array
[
Byte
],
Product
]
Definition Classes
HttpEndpointProvider
def
entity
(
e:
Any
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
entity
(
e:
Any
,
c:
MediaType
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
entity
(
e:
Any
,
c:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
final
def
eq
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
def
equals
(
arg0:
Any
)
:
Boolean
Definition Classes
AnyRef → Any
implicit
val
executor
:
ExecutionContext
Definition Classes
HttpEndpointProvider → ResponseBuilder
def
expectationFailed
:
HttpResponse
Definition Classes
ResponseBuilder
def
finalize
()
:
Unit
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
classOf[java.lang.Throwable]
)
def
forbidden
(
reason:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
forbidden
:
HttpResponse
Definition Classes
ResponseBuilder
def
found
:
HttpResponse
Definition Classes
ResponseBuilder
implicit
def
futureEntity2FutureResponse
(
future:
Future
[
Any
]
)
:
Future
[
HttpResponse
]
Definition Classes
ResponseBuilder
def
gatewayTimeout
:
HttpResponse
Definition Classes
ResponseBuilder
def
get
(
url:
String
)
:
HttpEndpointBuilder
[
Array
[
Byte
],
Product
]
Definition Classes
HttpEndpointProvider
final
def
getClass
()
:
Class
[_]
Definition Classes
AnyRef → Any
def
gone
:
HttpResponse
Definition Classes
ResponseBuilder
def
hashCode
()
:
Int
Definition Classes
AnyRef → Any
def
head
(
url:
String
)
:
HttpEndpointBuilder
[
Array
[
Byte
],
Product
]
Definition Classes
HttpEndpointProvider
def
httpEndpoints
(
serverBefores:
List
[
Processor
]
,
serverAfters:
List
[
Processor
]
)
:
Seq
[
HttpEndpoint
]
Definition Classes
HttpEndpointProvider
def
internalServerError
(
reason:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
internalServerError
:
HttpResponse
Definition Classes
ResponseBuilder
final
def
isInstanceOf
[
T0
]
:
Boolean
Definition Classes
Any
def
json
(
e:
Any
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
lengthRequired
:
HttpResponse
Definition Classes
ResponseBuilder
def
methodNotAllowed
:
HttpResponse
Definition Classes
ResponseBuilder
def
movedPermanently
:
HttpResponse
Definition Classes
ResponseBuilder
final
def
ne
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
def
nocontent
:
HttpResponse
Definition Classes
ResponseBuilder
def
nonAuthoritativeInformation
:
HttpResponse
Definition Classes
ResponseBuilder
def
notAcceptable
:
HttpResponse
Definition Classes
ResponseBuilder
def
notFound
(
body:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
notFound
:
HttpResponse
Definition Classes
ResponseBuilder
def
notImplemented
:
HttpResponse
Definition Classes
ResponseBuilder
def
notImplemented
(
reason:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
notModified
:
HttpResponse
Definition Classes
ResponseBuilder
final
def
notify
()
:
Unit
Definition Classes
AnyRef
final
def
notifyAll
()
:
Unit
Definition Classes
AnyRef
def
ok
(
e:
Any
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
ok
:
HttpResponse
Definition Classes
ResponseBuilder
def
options
(
url:
String
)
:
HttpEndpointBuilder
[
Array
[
Byte
],
Product
]
Definition Classes
HttpEndpointProvider
def
partialContent
:
HttpResponse
Definition Classes
ResponseBuilder
def
paymentRequired
:
HttpResponse
Definition Classes
ResponseBuilder
def
permanentRedirect
(
location:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
post
(
url:
String
)
:
HttpEndpointBuilder
[
Array
[
Byte
],
Product
]
Definition Classes
HttpEndpointProvider
def
preconditionFailed
:
HttpResponse
Definition Classes
ResponseBuilder
def
prefix
(
prefix:
String
)
:
Unit
Definition Classes
HttpEndpointProvider
var
prefix
:
Option
[
String
]
Attributes
protected[
com.sksamuel.scruffy
]
Definition Classes
HttpEndpointProvider
def
proxyAuthenticationRequired
:
HttpResponse
Definition Classes
ResponseBuilder
def
put
(
url:
String
)
:
HttpEndpointBuilder
[
Array
[
Byte
],
Product
]
Definition Classes
HttpEndpointProvider
def
requestEntityTooLarge
:
HttpResponse
Definition Classes
ResponseBuilder
def
requestHeaderFieldsTooLarge
:
HttpResponse
Definition Classes
ResponseBuilder
def
requestTimeout
:
HttpResponse
Definition Classes
ResponseBuilder
def
requestURITooLong
:
HttpResponse
Definition Classes
ResponseBuilder
def
requestedRangeNotSatisfiable
:
HttpResponse
Definition Classes
ResponseBuilder
def
resetContent
:
HttpResponse
Definition Classes
ResponseBuilder
implicit
def
response2future
(
resp:
HttpResponse
)
:
Future
[
HttpResponse
]
Definition Classes
ResponseBuilder
def
seeOther
(
location:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
serviceUnavailable
:
HttpResponse
Definition Classes
ResponseBuilder
def
static
(
url:
String
)
:
StaticEndpointBuilder
Definition Classes
StaticEndpointProvider
val
staticEndpoints
:
ListBuffer
[
StaticEndpointBuilder
]
Definition Classes
StaticEndpointProvider
def
status
(
s:
Int
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
status
(
s:
HttpStatus
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
status
(
s:
HttpResponseStatus
)
:
HttpResponse
Definition Classes
ResponseBuilder
implicit
def
status2future
(
status:
HttpStatus
)
:
Future
[
HttpResponse
]
Definition Classes
ResponseBuilder
implicit
def
status2future
(
code:
Int
)
:
Future
[
HttpResponse
]
Definition Classes
ResponseBuilder
implicit
def
status2response
(
s:
Int
)
:
HttpResponse
Definition Classes
ResponseBuilder
implicit
def
status2response
(
s:
HttpStatus
)
:
HttpResponse
Definition Classes
ResponseBuilder
final
def
synchronized
[
T0
]
(
arg0: ⇒
T0
)
:
T0
Definition Classes
AnyRef
def
temporaryRedirect
(
location:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
toString
()
:
String
Definition Classes
AnyRef → Any
def
trace
(
url:
String
)
:
HttpEndpointBuilder
[
Array
[
Byte
],
Product
]
Definition Classes
HttpEndpointProvider
def
unauthorized
:
HttpResponse
Definition Classes
ResponseBuilder
def
unprocessableEntity
(
reason:
String
)
:
HttpResponse
Definition Classes
ResponseBuilder
def
unprocessableEntity
:
HttpResponse
Definition Classes
ResponseBuilder
def
unsupportedMediaType
:
HttpResponse
Definition Classes
ResponseBuilder
def
useProxy
:
HttpResponse
Definition Classes
ResponseBuilder
final
def
wait
()
:
Unit
Definition Classes
AnyRef
Annotations
@throws
(
...
)
final
def
wait
(
arg0:
Long
,
arg1:
Int
)
:
Unit
Definition Classes
AnyRef
Annotations
@throws
(
...
)
final
def
wait
(
arg0:
Long
)
:
Unit
Definition Classes
AnyRef
Annotations
@throws
(
...
)
def
websocket
(
path:
String
)
(
f: ⇒
WebsocketHandler
)
:
Unit
Definition Classes
WebsocketResourceProvider
val
websocketEndpoints
:
ListBuffer
[
WebsocketEndpoint
]
Attributes
protected[
com.sksamuel.scruffy
]
Definition Classes
WebsocketResourceProvider
def
xml
(
e:
Any
)
:
HttpResponse
Definition Classes
ResponseBuilder
Inherited from
CorsSupport
Inherited from
EndpointProvider
Inherited from
StaticEndpointProvider
Inherited from
WebsocketResourceProvider
Inherited from
HttpEndpointProvider
Inherited from
ResponseBuilder
Inherited from
AnyRef
Inherited from
Any
Ungrouped