endpoints
.
akkahttp
.
client
Endpoints
Related Doc:
package client
class
Endpoints
extends
algebra.Endpoints
with
Urls
with
Methods
Source
Endpoints.scala
Linear Supertypes
Methods
,
Urls
,
algebra.Endpoints
,
Responses
,
Requests
,
endpoints.SemigroupalSyntax
,
endpoints.InvariantFunctorSyntax
,
algebra.Methods
,
algebra.Urls
,
AnyRef
,
Any
Ordering
Alphabetic
By Inheritance
Inherited
Endpoints
Methods
Urls
Endpoints
Responses
Requests
SemigroupalSyntax
InvariantFunctorSyntax
Methods
Urls
AnyRef
Any
Hide All
Show All
Visibility
Public
All
Instance Constructors
new
Endpoints
(
settings:
EndpointsSettings
)
(
implicit
EC:
ExecutionContext
,
M:
Materializer
)
Type Members
type
Endpoint
[
A
,
B
]
= (
A
) ⇒
Future
[
B
]
Definition Classes
Endpoints
→ Endpoints
case class
InvalidHeaderDefinition
(
parsingResult:
ParsingResult
)
extends
RuntimeException
with
Product
with
Serializable
implicit
class
InvariantFunctorSyntax
[
A
,
F
[
_
]
]
extends
AnyRef
Definition Classes
InvariantFunctorSyntax
type
Method
= (
HttpRequest
) ⇒
HttpRequest
Definition Classes
Methods
→ Methods
trait
Path
[
A
]
extends
Url
[
A
]
Definition Classes
Urls
implicit
class
PathOps
[
A
]
extends
AnyRef
Definition Classes
Urls
trait
QueryString
[
A
]
extends
AnyRef
Definition Classes
Urls
implicit
class
QueryStringOps
[
A
]
extends
AnyRef
Definition Classes
Urls
type
QueryStringParam
[
A
]
= (
A
) ⇒
String
Definition Classes
Urls
→ Urls
type
Request
[
A
]
= (
A
) ⇒
Future
[
HttpResponse
]
Definition Classes
Endpoints
→ Requests
type
RequestEntity
[
A
]
= (
A
,
HttpRequest
) ⇒
HttpRequest
Definition Classes
Endpoints
→ Requests
type
RequestHeaders
[
A
]
= (
A
,
List
[
HttpHeader
]) ⇒
List
[
HttpHeader
]
Definition Classes
Endpoints
→ Requests
type
Response
[
A
]
= (
HttpResponse
) ⇒
Future
[
Either
[
Throwable
,
A
]]
Definition Classes
Endpoints
→ Responses
trait
Segment
[
A
]
extends
AnyRef
Definition Classes
Urls
implicit
class
SemigroupalSyntax
[
A
,
F
[
_
]
]
extends
AnyRef
Definition Classes
SemigroupalSyntax
trait
Url
[
A
]
extends
AnyRef
Definition Classes
Urls
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
Delete
: (
HttpRequest
) ⇒
HttpRequest
Definition Classes
Methods
→ Methods
implicit
val
EC
:
ExecutionContext
def
Get
: (
HttpRequest
) ⇒
HttpRequest
Definition Classes
Methods
→ Methods
implicit
val
M
:
Materializer
def
Options
: (
HttpRequest
) ⇒
HttpRequest
Definition Classes
Methods
→ Methods
def
Patch
: (
HttpRequest
) ⇒
HttpRequest
Definition Classes
Methods
→ Methods
def
Post
: (
HttpRequest
) ⇒
HttpRequest
Definition Classes
Methods
→ Methods
def
Put
: (
HttpRequest
) ⇒
HttpRequest
Definition Classes
Methods
→ Methods
final
def
asInstanceOf
[
T0
]
:
T0
Definition Classes
Any
def
chainPaths
[
A
,
B
]
(
first:
Path
[
A
]
,
second:
Path
[
B
]
)
(
implicit
tupler:
Tupler
[
A
,
B
]
)
:
Path
[
Out
]
Definition Classes
Urls
→ Urls
def
clone
()
:
AnyRef
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
...
)
def
combineQueryStrings
[
A
,
B
]
(
first:
QueryString
[
A
]
,
second:
QueryString
[
B
]
)
(
implicit
tupler:
Tupler
[
A
,
B
]
)
:
QueryString
[
Out
]
Definition Classes
Urls
→ Urls
def
createHeader
(
name:
String
,
value:
String
)
:
HttpHeader
Attributes
protected
implicit
def
dummyPathToUrl
[
A
]
(
p:
Path
[
A
]
)
:
Url
[
A
]
Definition Classes
Urls
lazy val
emptyHeaders
:
RequestHeaders
[
Unit
]
Definition Classes
Endpoints
→ Requests
lazy val
emptyRequest
:
RequestEntity
[
Unit
]
Definition Classes
Endpoints
→ Requests
def
emptyResponse
(
docs:
Documentation
)
: (
HttpResponse
) ⇒
Future
[
Either
[
Throwable
,
Unit
]]
Definition Classes
Endpoints
→ Responses
def
endpoint
[
A
,
B
]
(
request:
Request
[
A
]
,
response:
Response
[
B
]
,
summary:
Documentation
,
description:
Documentation
)
:
Endpoint
[
A
,
B
]
Definition Classes
Endpoints
→ Endpoints
final
def
eq
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
def
equals
(
arg0:
Any
)
:
Boolean
Definition Classes
AnyRef → Any
def
finalize
()
:
Unit
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
classOf[java.lang.Throwable]
)
final
def
get
[
UrlP
,
HeadersP
]
(
url:
Url
[
UrlP
]
,
headers:
RequestHeaders
[
HeadersP
]
)
(
implicit
tuplerAC:
Tupler
[
UrlP
,
HeadersP
]
)
:
Request
[
Out
]
Definition Classes
Requests
final
def
getClass
()
:
Class
[_]
Definition Classes
AnyRef → Any
def
hashCode
()
:
Int
Definition Classes
AnyRef → Any
def
header
(
name:
String
,
docs:
Option
[
String
]
)
: (
String
,
List
[
HttpHeader
]) ⇒
List
[
HttpHeader
]
Definition Classes
Endpoints
→ Requests
implicit
lazy val
intQueryString
:
QueryStringParam
[
Int
]
Definition Classes
Urls
→ Urls
implicit
lazy val
intSegment
:
Segment
[
Int
]
Definition Classes
Urls
→ Urls
final
def
isInstanceOf
[
T0
]
:
Boolean
Definition Classes
Any
implicit
lazy val
longQueryString
:
QueryStringParam
[
Long
]
Definition Classes
Urls
→ Urls
implicit
lazy val
longSegment
:
Segment
[
Long
]
Definition Classes
Urls
→ Urls
final
def
ne
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
final
def
notify
()
:
Unit
Definition Classes
AnyRef
final
def
notifyAll
()
:
Unit
Definition Classes
AnyRef
def
optHeader
(
name:
String
,
docs:
Option
[
String
]
)
: (
Option
[
String
],
List
[
HttpHeader
]) ⇒
List
[
HttpHeader
]
Definition Classes
Endpoints
→ Requests
def
optQs
[
A
]
(
name:
String
,
docs:
Documentation
)
(
implicit
value:
QueryStringParam
[
A
]
)
:
QueryString
[
Option
[
A
]]
Definition Classes
Urls
→ Urls
def
option
[
A
]
(
inner: (
HttpResponse
) ⇒
Future
[
Either
[
Throwable
,
A
]]
,
notFoundDocs:
Documentation
)
: (
HttpResponse
) ⇒
Future
[
Either
[
Throwable
,
Option
[
A
]]]
Definition Classes
Endpoints
→ Responses
val
path
:
Path
[
Unit
]
Definition Classes
Urls
final
def
post
[
UrlP
,
BodyP
,
HeadersP
,
UrlAndBodyPTupled
]
(
url:
Url
[
UrlP
]
,
entity:
RequestEntity
[
BodyP
]
,
headers:
RequestHeaders
[
HeadersP
]
)
(
implicit
tuplerAB:
Tupler.Aux
[
UrlP
,
BodyP
,
UrlAndBodyPTupled
]
,
tuplerABC:
Tupler
[
UrlAndBodyPTupled
,
HeadersP
]
)
:
Request
[
Out
]
Definition Classes
Requests
def
qs
[
A
]
(
name:
String
,
docs:
Documentation
)
(
implicit
value:
QueryStringParam
[
A
]
)
:
QueryString
[
A
]
Definition Classes
Urls
→ Urls
implicit
lazy val
reqEntityInvFunctor
:
InvariantFunctor
[
RequestEntity
]
Definition Classes
Endpoints
→ Requests
implicit
lazy val
reqHeadersInvFunctor
:
InvariantFunctor
[
RequestHeaders
]
Definition Classes
Endpoints
→ Requests
implicit
lazy val
reqHeadersSemigroupal
:
Semigroupal
[
RequestHeaders
]
Definition Classes
Endpoints
→ Requests
def
request
[
A
,
B
,
C
,
AB
]
(
method:
Method
,
url:
Url
[
A
]
,
entity:
RequestEntity
[
B
]
,
headers:
RequestHeaders
[
C
]
)
(
implicit
tuplerAB:
Tupler.Aux
[
A
,
B
,
AB
]
,
tuplerABC:
Tupler
[
AB
,
C
]
)
:
Request
[
Out
]
Definition Classes
Endpoints
→ Requests
def
segment
[
A
]
(
name:
String
,
docs:
Documentation
)
(
implicit
s:
Segment
[
A
]
)
:
Path
[
A
]
Definition Classes
Urls
→ Urls
val
settings
:
EndpointsSettings
def
staticPathSegment
(
segment:
String
)
:
Path
[
Unit
] with
Serializable
Definition Classes
Urls
→ Urls
implicit
lazy val
stringQueryString
:
QueryStringParam
[
String
]
Definition Classes
Urls
→ Urls
implicit
lazy val
stringSegment
:
Segment
[
String
]
Definition Classes
Urls
→ Urls
final
def
synchronized
[
T0
]
(
arg0: ⇒
T0
)
:
T0
Definition Classes
AnyRef
def
textRequest
(
docs:
Option
[
String
]
)
: (
String
,
HttpRequest
) ⇒
HttpRequest
Definition Classes
Endpoints
→ Requests
def
textResponse
(
docs:
Documentation
)
: (
HttpResponse
) ⇒
Future
[
Either
[
Throwable
,
String
]]
Definition Classes
Endpoints
→ Responses
def
toString
()
:
String
Definition Classes
AnyRef → Any
implicit
lazy val
urlInvFunctor
:
InvariantFunctor
[
Url
]
Definition Classes
Urls
→ Urls
def
urlWithQueryString
[
A
,
B
]
(
path:
Path
[
A
]
,
qs:
QueryString
[
B
]
)
(
implicit
tupler:
Tupler
[
A
,
B
]
)
:
Url
[
Out
]
Definition Classes
Urls
→ Urls
val
utf8Name
:
String
Definition Classes
Urls
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
(
...
)
Inherited from
Methods
Inherited from
Urls
Inherited from
algebra.Endpoints
Inherited from
Responses
Inherited from
Requests
Inherited from
endpoints.SemigroupalSyntax
Inherited from
endpoints.InvariantFunctorSyntax
Inherited from
algebra.Methods
Inherited from
algebra.Urls
Inherited from
AnyRef
Inherited from
Any
Ungrouped