trait Endpoints extends EndpointsWithCustomErrors with BuiltInErrors
Algebra interface for describing endpoints made of requests and responses.
Requests and responses contain headers and entity.
/** * Describes an HTTP endpoint whose: * - request uses verb “GET”, * - URL is made of path “/foo”, * - response has no entity */ val example = endpoint(get(path / "foo"), emptyResponse)
This trait uses BuiltInErrors to model client and server errors.
- Alphabetic
- By Inheritance
- Endpoints
- BuiltInErrors
- EndpointsWithCustomErrors
- Errors
- Responses
- StatusCodes
- Requests
- SemigroupalSyntax
- Methods
- Urls
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
implicit
class
SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
-
type
CallbacksDocs = Map[String, CallbackDocs]
Callbacks indexed by URL pattern
Callbacks indexed by URL pattern
- Definition Classes
- EndpointsWithCustomErrors
- See also
Swagger Documentation at https://swagger.io/docs/specification/callbacks/
-
type
ClientErrors = Invalid
Errors in a request built by a client
Errors in a request built by a client
- Definition Classes
- BuiltInErrors → Errors
-
abstract
type
Endpoint[A, B]
Information carried by an HTTP endpoint
Information carried by an HTTP endpoint
Values of type Endpoint can be constructed by using the operation endpoint.
- Definition Classes
- EndpointsWithCustomErrors
-
implicit
class
InvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- InvariantFunctorSyntax
-
abstract
type
Method
HTTP Method
HTTP Method
- Definition Classes
- Methods
-
implicit
class
PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
-
abstract
type
Path[A] <: Url[A]
An URL path carrying an
A
informationAn URL path carrying an
A
informationValues of type
Path[A]
can be constructed by the operations path, segment, and remainingSegments.path / "user" / segment[UUID]("id")
- Server interpreters raise an error if they can’t parse the incoming
request path as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Definition Classes
- Urls
- Note
This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
- Server interpreters raise an error if they can’t parse the incoming
request path as a value of type
-
abstract
type
QueryString[A]
A query string carrying an
A
informationA query string carrying an
A
informationQueryString values can be created with the qs operation, and can be combined with the
&
operation:val queryPageAndLang: QueryString[(Int, Option[String])] = qs[Int]("page") & qs[Option[String]]("lang")
- Server interpreters raise an error if they can’t parse the incoming
request query string parameters as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Definition Classes
- Urls
- Note
This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
- Server interpreters raise an error if they can’t parse the incoming
request query string parameters as a value of type
-
abstract
type
QueryStringParam[A]
A query string parameter codec for type
A
.A query string parameter codec for type
A
.The trait
Urls
provides implicit instances of typeQueryStringParam[A]
for basic types (e.g.,Int
,String
, etc.). You can create additional instances by transforming or refining the existing instances withxmap
andxmapPartial
.- Definition Classes
- Urls
- Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
-
abstract
type
Request[A]
Information carried by a whole request (headers and entity)
Information carried by a whole request (headers and entity)
Values of type
Request[A]
can be constructed by using the operations request, get, post, put, or delete.- Server interpreters raise an error if they can’t parse the incoming
request as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Definition Classes
- Requests
- Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax class.
- Server interpreters raise an error if they can’t parse the incoming
request as a value of type
-
abstract
type
RequestEntity[A]
Information carried by request entity
Information carried by request entity
Values of type
RequestEntity[A]
can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.- Server interpreters raise an error if they can’t parse the incoming
request entity as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Definition Classes
- Requests
- Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestEntitySyntax classes.
- Server interpreters raise an error if they can’t parse the incoming
request entity as a value of type
-
abstract
type
RequestHeaders[A]
Information carried by requests’ headers.
Information carried by requests’ headers.
You can construct values of type
RequestHeaders
by using the operations requestHeader, optRequestHeader, or emptyRequestHeaders.- Server interpreters raise an error if they can’t parse the incoming
request headers as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Definition Classes
- Requests
- Note
This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.
- Server interpreters raise an error if they can’t parse the incoming
request headers as a value of type
-
abstract
type
Response[A]
An HTTP response (status, headers, and entity) carrying an information of type A
An HTTP response (status, headers, and entity) carrying an information of type A
Values of type
Response[A]
can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.- Definition Classes
- Responses
- Note
This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes
-
abstract
type
ResponseEntity[A]
An HTTP response entity carrying an information of type A
An HTTP response entity carrying an information of type A
Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.
- Definition Classes
- Responses
- Note
This type has implicit methods provided by the InvariantFunctorSyntax class
-
abstract
type
ResponseHeaders[A]
Information carried by responses’ headers.
Information carried by responses’ headers.
You can construct values of type
ResponseHeaders
by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.- Definition Classes
- Responses
- Note
This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.
-
abstract
type
Segment[A]
An URL path segment codec for type
A
.An URL path segment codec for type
A
.The trait
Urls
provides implicit instances ofSegment[A]
for basic types (e.g.,Int
,String
, etc.). You can create additional instances by transforming or refining the existing instances withxmap
andxmapPartial
.- Definition Classes
- Urls
- Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
-
type
ServerError = Throwable
Error raised by the business logic of a server
Error raised by the business logic of a server
- Definition Classes
- BuiltInErrors → Errors
-
abstract
type
StatusCode
HTTP Status Code
HTTP Status Code
- Definition Classes
- StatusCodes
-
abstract
type
Url[A]
An URL carrying an
A
informationAn URL carrying an
A
informationValues of type
URL[A]
are typically constructed by first using the path constructor and then chaining it with segments and query parameters.path / "users" / segment[UUID]("id") /? qs[String]("apiKey")
- Server interpreters raise an error if they can’t parse the incoming
request URL as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Definition Classes
- Urls
- Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.
- Server interpreters raise an error if they can’t parse the incoming
request URL as a value of type
-
final
class
CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
final
class
EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
implicit
class
RequestEntitySyntax[A] extends AnyRef
- Definition Classes
- Requests
-
implicit
class
ResponseSyntax[A] extends AnyRef
Extension methods for Response.
-
implicit
class
PathOps[A] extends AnyRef
Convenient methods for Paths.
-
implicit
class
QueryStringSyntax[A] extends AnyRef
Extension methods on QueryString.
Extension methods on QueryString.
- Definition Classes
- Urls
Abstract Value Members
-
abstract
def
Accepted: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
BadRequest: StatusCode
- Definition Classes
- StatusCodes
- Note
You should use the
badRequest
constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.
-
abstract
def
Created: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
Delete: Method
- Definition Classes
- Methods
-
abstract
def
Forbidden: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
Get: Method
- Definition Classes
- Methods
-
abstract
def
InternalServerError: StatusCode
- Definition Classes
- StatusCodes
- Note
You should use the
internalServerError
constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.
-
abstract
def
NoContent: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
NotFound: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
NotImplemented: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
OK: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
Options: Method
- Definition Classes
- Methods
-
abstract
def
Patch: Method
- Definition Classes
- Methods
-
abstract
def
PayloadTooLarge: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
Post: Method
- Definition Classes
- Methods
-
abstract
def
Put: Method
- Definition Classes
- Methods
-
abstract
def
TooManyRequests: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
Unauthorized: StatusCode
- Definition Classes
- StatusCodes
-
abstract
def
chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
Chains the two paths
Chains the two paths
- Definition Classes
- Urls
-
abstract
def
choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
Alternative between two possible request entities, differentiated by the
Content-Type
headerAlternative between two possible request entities, differentiated by the
Content-Type
header- Definition Classes
- Requests
- Note
If A and B are both JSON-encoded and use disjoint schemas, use endpoints4s.algebra.JsonSchemas.TaggedOps#orElse at the schema level instead
- Server interpreters accept either of the request entities
- Client interpreters provide one of the two request entities
- Documentation interpreters list all possible content types and their entities
-
abstract
def
choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
Alternative between two possible choices of responses.
Alternative between two possible choices of responses.
Server interpreters construct either one or the other response. Client interpreters accept either one or the other response. Documentation interpreters list all the possible responses.
- Definition Classes
- Responses
-
abstract
def
clientErrorsResponseEntity: ResponseEntity[Invalid]
Response entity format for Invalid values
Response entity format for Invalid values
- Definition Classes
- BuiltInErrors → Errors
-
abstract
def
combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
Concatenates two
QueryString
sConcatenates two
QueryString
s- Definition Classes
- Urls
-
abstract
def
emptyRequest: RequestEntity[Unit]
Empty request -- request without a body.
Empty request -- request without a body. Use
description
of endpoints4s.algebra.Endpoints#endpoint to document an empty body.- Definition Classes
- Requests
-
abstract
def
emptyRequestHeaders: RequestHeaders[Unit]
Ignore headers
Ignore headers
- Server interpreters don’t try to parse any information from the request headers,
- Client interpreters supply no specific headers
Use
description
of endpoints4s.algebra.Endpoints#endpoint to document empty headers.- Definition Classes
- Requests
-
abstract
def
emptyResponse: ResponseEntity[Unit]
Empty response entity
Empty response entity
- Server interpreters produce no response entity,
- Client interpreters ignore the response entity.
- Definition Classes
- Responses
-
abstract
def
emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header.
- Client interpreters should ignore information carried by response headers.
- Definition Classes
- Responses
-
abstract
def
endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
Define an HTTP endpoint
Define an HTTP endpoint
- request
Request
- response
Response
- docs
Documentation (used by documentation interpreters)
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
def
optRequestHeader(name: String, docs: Documentation = None): RequestHeaders[Option[String]]
An optional request header
-
abstract
def
optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
Response headers optionally containing a header with the given
name
.Response headers optionally containing a header with the given
name
.- Client interpreters should model the header value as
Some[String]
, orNone
if the response header is missing. - Server interpreters should produce such a response header.
- Documentation interpreters should document this header.
- Definition Classes
- Responses
- Client interpreters should model the header value as
-
implicit abstract
def
optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]
Make a query string parameter optional:
Make a query string parameter optional:
path / "articles" /? qs[Option[Int]]("page")
- Client interpreters must omit optional query string parameters that are empty.
- Server interpreters must accept incoming requests whose optional query string parameters are missing, and they must report a failure for incoming requests whose optional query string parameters are present, but malformed,
- Documentation interpreters should mark the parameter as optional.
- Definition Classes
- Urls
-
implicit abstract
def
pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
Provides
xmap
andxmapPartial
operations.Provides
xmap
andxmapPartial
operations.- Definition Classes
- Urls
- See also
-
abstract
def
qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]
Builds a
QueryString
with one parameter.Builds a
QueryString
with one parameter.Examples:
qs[Int]("page") // mandatory `page` parameter qs[Option[String]]("lang") // optional `lang` parameter qs[List[Long]]("id") // repeated `id` parameter
- A
Type of the value carried by the parameter
- name
Parameter’s name
- Definition Classes
- Urls
-
implicit abstract
def
queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
Provides
xmap
andxmapPartial
operations.Provides
xmap
andxmapPartial
operations.- Definition Classes
- Urls
- See also
-
implicit abstract
def
queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
Provides
xmap
andxmapPartial
operations.Provides
xmap
andxmapPartial
operations.- Definition Classes
- Urls
- See also
-
abstract
def
remainingSegments(name: String = "", docs: Documentation = None): Path[String]
The remaining segments of the path.
The remaining segments of the path. The
String
value carried by thisPath
is still URL-encoded.- Definition Classes
- Urls
-
implicit abstract
def
repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit arg0: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]
Support query string parameters with multiple values:
Support query string parameters with multiple values:
path / "articles" /? qs[List[Long]]("id")
- Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.
- Definition Classes
- Urls
-
abstract
def
request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Request for given parameters
Request for given parameters
- UrlP
Payload carried by url
- BodyP
Payload carried by body
- HeadersP
Payload carried by headers
- UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler
- method
Request method
- url
Request URL
- entity
Request entity
- docs
Request documentation
- headers
Request headers
- Definition Classes
- Requests
-
implicit abstract
def
requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- Requests
- See also
-
abstract
def
requestHeader(name: String, docs: Documentation = None): RequestHeaders[String]
A required request header
-
implicit abstract
def
requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- Requests
- See also
-
implicit abstract
def
requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides
++
operation.Provides
++
operation.- Definition Classes
- Requests
- See also
-
implicit abstract
def
requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- Requests
- See also
-
abstract
def
response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
Define an HTTP response
Define an HTTP response
- Server interpreters construct a response with the given status and entity.
- Client interpreters accept a response only if it has a corresponding status code.
- statusCode
Response status code
- entity
Response entity
- docs
Response documentation
- headers
Response headers
- Definition Classes
- Responses
-
implicit abstract
def
responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
- Definition Classes
- Responses
-
abstract
def
responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
Response headers containing a header with the given
name
.Response headers containing a header with the given
name
.- Client interpreters should model the header value as
String
, or fail if the response header is missing. - Server interpreters should produce such a response header.
- Documentation interpreters should document this header.
Example:
val versionedResource: Endpoint[Unit, (SomeResource, String)] = endpoint( get(path / "versioned-resource"), ok( jsonResponse[SomeResource], headers = responseHeader("ETag") ) )
- Definition Classes
- Responses
- Client interpreters should model the header value as
-
implicit abstract
def
responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides
xmap
operation.Provides
xmap
operation.- Definition Classes
- Responses
- See also
-
implicit abstract
def
responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides
++
operation.Provides
++
operation.- Definition Classes
- Responses
- See also
-
implicit abstract
def
responseInvariantFunctor: InvariantFunctor[Response]
Provides the operation
xmap
to the typeResponse
Provides the operation
xmap
to the typeResponse
- Definition Classes
- Responses
- See also
-
abstract
def
segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]
A path segment carrying an
A
informationA path segment carrying an
A
information- Definition Classes
- Urls
-
implicit abstract
def
segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
Provides
xmap
andxmapPartial
operations.Provides
xmap
andxmapPartial
operations.- Definition Classes
- Urls
- See also
-
abstract
def
serverErrorResponseEntity: ResponseEntity[Throwable]
Response entity format for
Throwable
valuesResponse entity format for
Throwable
values- Definition Classes
- BuiltInErrors → Errors
-
abstract
def
staticPathSegment(segment: String): Path[Unit]
A path segment whose value is the given
segment
A path segment whose value is the given
segment
- Definition Classes
- Urls
-
implicit abstract
def
stringQueryString: QueryStringParam[String]
Ability to define
String
query string parametersAbility to define
String
query string parameters- Definition Classes
- Urls
-
implicit abstract
def
stringSegment: Segment[String]
Path segment codec for type
String
Path segment codec for type
String
- Server interpreters should return an URL-decoded string value,
- Client interpreters should take an URL-decoded string value.
- Definition Classes
- Urls
-
abstract
def
textRequest: RequestEntity[String]
Request with a
String
body.Request with a
String
body.- Server interpreters accept requests with content-type
text/plain
and reject requests with an incorrect content-type. - Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
- Client interpreters supply content-type
text/plain
with an explicit character encoding
- Definition Classes
- Requests
- Server interpreters accept requests with content-type
-
abstract
def
textResponse: ResponseEntity[String]
Text response entity
Text response entity
- Server interpreters produce an HTTP response with a
text/plain
content type.
- Definition Classes
- Responses
- Server interpreters produce an HTTP response with a
-
implicit abstract
def
urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
Provides
xmap
andxmapPartial
operationsProvides
xmap
andxmapPartial
operations- Definition Classes
- Urls
- See also
-
abstract
def
urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
Builds an URL from the given path and query string
Builds an URL from the given path and query string
- Definition Classes
- Urls
Concrete 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
AlreadyReported: StatusCode
- Definition Classes
- StatusCodes
-
def
Conflict: StatusCode
- Definition Classes
- StatusCodes
-
def
ExpectationFailed: StatusCode
- Definition Classes
- StatusCodes
-
def
FailedDependency: StatusCode
- Definition Classes
- StatusCodes
-
def
Gone: StatusCode
- Definition Classes
- StatusCodes
-
def
IMUsed: StatusCode
- Definition Classes
- StatusCodes
-
def
LengthRequired: StatusCode
- Definition Classes
- StatusCodes
-
def
Locked: StatusCode
- Definition Classes
- StatusCodes
-
def
MethodNotAllowed: StatusCode
- Definition Classes
- StatusCodes
-
def
MisdirectedRequest: StatusCode
- Definition Classes
- StatusCodes
-
def
MultiStatus: StatusCode
- Definition Classes
- StatusCodes
-
def
NonAuthoritativeInformation: StatusCode
- Definition Classes
- StatusCodes
-
def
NotAcceptable: StatusCode
- Definition Classes
- StatusCodes
-
def
PartialContent: StatusCode
- Definition Classes
- StatusCodes
-
def
PaymentRequired: StatusCode
- Definition Classes
- StatusCodes
-
def
PreconditionFailed: StatusCode
- Definition Classes
- StatusCodes
-
def
PreconditionRequired: StatusCode
- Definition Classes
- StatusCodes
-
def
ProxyAuthenticationRequired: StatusCode
- Definition Classes
- StatusCodes
-
def
RangeNotSatisfiable: StatusCode
- Definition Classes
- StatusCodes
-
def
RequestHeaderFieldsTooLarge: StatusCode
- Definition Classes
- StatusCodes
-
def
RequestTimeout: StatusCode
- Definition Classes
- StatusCodes
-
def
ResetContent: StatusCode
- Definition Classes
- StatusCodes
-
def
TooEarly: StatusCode
- Definition Classes
- StatusCodes
-
def
UnavailableForLegalReasons: StatusCode
- Definition Classes
- StatusCodes
-
def
UnprocessableEntity: StatusCode
- Definition Classes
- StatusCodes
-
def
UnsupportedMediaType: StatusCode
- Definition Classes
- StatusCodes
-
def
UpgradeRequired: StatusCode
- Definition Classes
- StatusCodes
-
def
UriTooLong: StatusCode
- Definition Classes
- StatusCodes
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
badRequest[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
Bad Request (400) response, with an entity of type
ClientErrors
.Bad Request (400) response, with an entity of type
ClientErrors
.- Definition Classes
- Responses
- See also
endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors
-
implicit
def
booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a
Boolean
valueQuery string parameter containing a
Boolean
value- Definition Classes
- Urls
-
lazy val
clientErrorsResponse: Response[ClientErrors]
Response used by endpoints4s when decoding a request fails.
Response used by endpoints4s when decoding a request fails.
The provided implementation forwards to
badRequest
.- Definition Classes
- Errors
-
final
def
clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
Convert the ClientErrors type into the endpoints4s internal client error type
Convert the ClientErrors type into the endpoints4s internal client error type
- Definition Classes
- BuiltInErrors → Errors
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
Helper method to perform DELETE request
Helper method to perform DELETE request
- UrlP
Payload carried by url
- HeadersP
Payload carried by headers
- Definition Classes
- Requests
-
implicit
def
doubleQueryString: QueryStringParam[Double]
Codec for query string parameters of type
Double
Codec for query string parameters of type
Double
- Definition Classes
- Urls
-
implicit
def
doubleSegment: Segment[Double]
Path segment codec for type
Double
Path segment codec for type
Double
- Definition Classes
- Urls
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
Helper method to perform GET request
Helper method to perform GET request
- UrlP
Payload carried by url
- HeadersP
Payload carried by headers
- Definition Classes
- Requests
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
implicit
def
intQueryString: QueryStringParam[Int]
Ability to define
Int
query string parametersAbility to define
Int
query string parameters- Definition Classes
- Urls
-
implicit
def
intSegment: Segment[Int]
Path segment codec for type
Int
Path segment codec for type
Int
- Definition Classes
- Urls
-
final
def
internalServerError[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
Internal Server Error (500) response, with an entity of type
ServerError
.Internal Server Error (500) response, with an entity of type
ServerError
.- Definition Classes
- Responses
- See also
endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors
-
final
def
invalidToClientErrors(invalid: Invalid): ClientErrors
Convert the endpoints4s internal client error type into the ClientErrors type
Convert the endpoints4s internal client error type into the ClientErrors type
- Definition Classes
- BuiltInErrors → Errors
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
implicit
def
longQueryString: QueryStringParam[Long]
Query string parameter containing a
Long
valueQuery string parameter containing a
Long
value- Definition Classes
- Urls
-
implicit
def
longSegment: Segment[Long]
Path segment codec for type
Long
Path segment codec for type
Long
- Definition Classes
- Urls
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
ok[A, B, R](entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
OK (200) Response with the given entity
OK (200) Response with the given entity
- Definition Classes
- Responses
-
final
def
patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform PATCH request
-
val
path: Path[Unit]
An empty path.
An empty path.
Useful to begin a path definition:
path / "foo" / segment[Int] /? qs[String]("bar")
- Definition Classes
- Urls
-
final
def
post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform POST request
-
final
def
put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform PUT request
-
lazy val
serverErrorResponse: Response[ServerError]
Response used by endpoints4s when the business logic of an endpoint fails.
Response used by endpoints4s when the business logic of an endpoint fails.
The provided implementation forwards to
internalServerError
- Definition Classes
- Errors
-
final
def
serverErrorToThrowable(serverError: ServerError): Throwable
Convert the ServerError type into the endpoints4s internal server error type
Convert the ServerError type into the endpoints4s internal server error type
- Definition Classes
- BuiltInErrors → Errors
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
throwableToServerError(throwable: Throwable): ServerError
Convert the endpoints4s internal server error type into the ServerError type
Convert the endpoints4s internal server error type into the ServerError type
- Definition Classes
- BuiltInErrors → Errors
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit
def
uuidQueryString: QueryStringParam[UUID]
Ability to define
UUID
query string parametersAbility to define
UUID
query string parameters- Definition Classes
- Urls
-
implicit
def
uuidSegment: Segment[UUID]
Path segment codec for type
UUID
Path segment codec for type
UUID
- Definition Classes
- Urls
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]
Turns a
Response[A]
into aResponse[Option[A]]
.Turns a
Response[A]
into aResponse[Option[A]]
.Interpreters represent
None
with an empty HTTP response whose status code is 404 (Not Found).- Definition Classes
- Responses
-
object
CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
object
EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
Inherited from BuiltInErrors
Inherited from EndpointsWithCustomErrors
Inherited from Errors
Inherited from Responses
Inherited from StatusCodes
Inherited from Requests
Inherited from endpoints4s.SemigroupalSyntax
Inherited from Methods
Inherited from Urls
Inherited from endpoints4s.PartialInvariantFunctorSyntax
Inherited from endpoints4s.InvariantFunctorSyntax
Inherited from AnyRef
Inherited from Any
Types
Types introduced by the algebra
Operations
Operations creating and transforming values