Endpoint
Related Docs:
object Endpoint
| package finch
Composes this endpoint with another in such a way that coproducts are flattened.
Composes this endpoint with the given Endpoint.
Lifts this endpoint into one that always succeeds, with A representing both success and failure cases.
Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response] where responses are encoded with JSON encoder.
Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response] where responses are encoded with JSON encoder.
Consider using io.finch.Bootstrap instead
Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response]
where responses are encoded with encoder corresponding to CT Content-Type.
Converts this endpoint to Endpoint.Compiled[F] what is efficiently is Kleisli[F, Request, Response]
where responses are encoded with encoder corresponding to CT Content-Type.
Consider using io.finch.Bootstrap instead
Sequentially composes this endpoint with the given other endpoint.
Sequentially composes this endpoint with the given other endpoint. The resulting endpoint
will succeed if either this or that endpoints are succeed.
- if both endpoints match, the result with a shorter remainder (in terms of consumed route) is picked - if both endpoints don't match, the more specific result (explaining the reason for not matching) is picked
Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
Request item (part) that's this endpoint work with.
Maps this endpoint to the given function A => B.
Maps this endpoint to the given function A => Future[B].
Maps this endpoint to the given function A => Output[B].
Maps this endpoint to the given function A => Future[Output[B]].
Returns a product of this and other endpoint.
Returns a product of this and other endpoint. The resulting endpoint returns a tuple
of both values.
This combinator is an important piece for Finch's error accumulation. In its current form,
product will accumulate Finch's own errors (i.e., io.finch.Errors) into io.finch.Errors) and
will fail-fast with the first non-Finch error (just ordinary Exception) observed.
Returns a product of this and other endpoint.
Returns a product of this and other endpoint. The resulting endpoint returns a value of
resulting type for product function.
Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
Validates the result of this endpoint using a predefined rule.
Validates the result of this endpoint using a predefined rule. This method allows for rules
to be reused across multiple endpoints.
the predefined ValidationRule that will return true if the data is valid
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.
Validates the result of this endpoint using a predicate.
Validates the result of this endpoint using a predicate. The rule is used for error
reporting.
text describing the rule being validated
returns true if the data is valid
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.
Validates the result of this endpoint using a predefined rule.
Validates the result of this endpoint using a predefined rule. This method allows for rules
to be reused across multiple endpoints.
the predefined ValidationRule that will return false if the data is valid
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.
Validates the result of this endpoint using a predicate.
Validates the result of this endpoint using a predicate. The rule is used for error reporting.
text describing the rule being validated
returns false if the data is valid
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.
Converts this endpoint to a Finagle service Request => Future[Response] that serves JSON.
Converts this endpoint to a Finagle service Request => Future[Response] that serves JSON.
Consider using io.finch.Bootstrap instead.
Converts this endpoint to a Finagle service Request => Future[Response] that serves custom
content-type CT.
Converts this endpoint to a Finagle service Request => Future[Response] that serves custom
content-type CT.
Consider using io.finch.Bootstrap instead.
Transform this endpoint to the given function F[A] => F[B]
Transforms this endpoint to the given function F[Output[A]] => F[Output[B]].
Transforms this endpoint to the given function F[Output[A]] => F[Output[B]].
Might be useful to perform some extra action on the underlying Future. For example, time
the latency of the given endpoint.
import io.finch._ import com.twitter.finagle.stats._ def time[A](stat: Stat, e: Endpoint[A]): Endpoint[A] = e.transform(f => Stat.timeFuture(s)(f))
Overrides the toString method on this endpoint.
An
Endpointrepresents the HTTP endpoint.It is well known and widely adopted in Finagle that "Your Server is a Function" (i.e.,
Request => Future[Response]). In a REST/HTTP API setting this function may be viewed asRequest =1=> (A =2=> Future[B]) =3=> Future[Response], where transformation1is a request decoding (deserialization), transformation2- is a business logic and transformation3is - a response encoding (serialization). The only interesting part here is transformation2(i.e.,A => Future[B]), which represents an application business.An
Endpointtransformation (map,mapAsync, etc.) encodes the business logic, while the rest of Finch ecosystem takes care about both serialization and deserialization.A typical way to transform (or map) the
Endpointis to use internal.Mapper:Endpoints are also composable in terms of or-else combinator (known as a "space invader" operator:+:) that takes twoEndpoints and returns a coproductEndpoint.An
Endpointmight be converted into a Finagle Service withEndpoint.toServicemethod so it can be served within Finagle HTTP.import com.twitter.finagle.Http Http.server.serve(foobar.toService)