trait Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors
Interpreter for algebra.Endpoints that performs routing using Play framework, and uses algebra.BuiltInErrors to model client and server errors.
Consider the following endpoints definition:
trait MyEndpoints extends algebra.Endpoints with algebra.JsonEntities { val inc = endpoint(get(path / "inc" ? qs[Int]("x")), jsonResponse[Int]) }
You can get a router for them as follows:
object MyRouter extends MyEndpoints with play.server.Endpoints with play.server.JsonEntities { val routes = routesFromEndpoints( inc.implementedBy(x => x + 1) ) }
Then MyRouter.routes
can be used to define a proper Play router as follows:
val router = play.api.routing.Router.from(MyRouter.routes)
- Source
- Endpoints.scala
- Grouped
- Alphabetic
- By Inheritance
- Endpoints
- BuiltInErrors
- EndpointsWithCustomErrors
- StatusCodes
- Methods
- Urls
- Endpoints
- BuiltInErrors
- EndpointsWithCustomErrors
- Errors
- Responses
- StatusCodes
- Requests
- SemigroupalSyntax
- Methods
- Urls
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
Extension methods for values of type
F[A]
for which there is an implicitInvariantFunctor[F]
instance.Extension methods for values of type
F[A]
for which there is an implicitInvariantFunctor[F]
instance.- Definition Classes
- InvariantFunctorSyntax
- implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
- implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
- case class CallbackDocs(method: EndpointsWithCustomErrors.Method, entity: EndpointsWithCustomErrors.RequestEntity[_], response: EndpointsWithCustomErrors.Response[_], requestDocs: Documentation = None) extends Product with Serializable
- method
HTTP method used for the callback
- entity
Contents of the callback message
- response
Expected response
- Definition Classes
- EndpointsWithCustomErrors
- case class EndpointDocs(summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil, callbacks: Map[String, CallbacksDocs] = Map.empty, deprecated: Boolean = false) extends Product with Serializable
- summary
Short description
- description
Detailed description
- tags
OpenAPI tags
- callbacks
Callbacks indexed by event name
- deprecated
Indicates whether this endpoint is deprecated or not
- Definition Classes
- EndpointsWithCustomErrors
- 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
- 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
- type RequestEntity[A] = BodyParser[A]
Decodes a request entity
Decodes a request entity
- Definition Classes
- EndpointsWithCustomErrors → Requests
- type RequestExtractor[A] = (RequestHeader) => Option[A]
Convenient type alias modeling the extraction of an
A
information from request headers.Convenient type alias modeling the extraction of an
A
information from request headers.This type has an instance of
Applicative
.- Definition Classes
- Urls
- type RequestHeaders[A] = (Headers) => Validated[A]
An attempt to extract an
A
from a request headers.An attempt to extract an
A
from a request headers.Models failure by returning a
Left(result)
. That makes it possible to early return an HTTP response if a header is wrong (e.g. if an authentication information is missing)- Definition Classes
- EndpointsWithCustomErrors → Requests
- type Response[A] = (A) => Result
Turns the
A
information into a proper PlayResult
Turns the
A
information into a proper PlayResult
- Definition Classes
- EndpointsWithCustomErrors → Responses
- type ResponseEntity[A] = (A) => HttpEntity
An HTTP response entity carrying an information of type A
An HTTP response entity carrying an information of type A
- Definition Classes
- EndpointsWithCustomErrors → Responses
- Note
This type has implicit methods provided by the InvariantFunctorSyntax class
- type ResponseHeaders[A] = (A) => Seq[(String, String)]
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
- EndpointsWithCustomErrors → Responses
- Note
This type has implicit methods provided by the SemigroupalSyntax and 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
- type StatusCode = play.api.mvc.Results.Status
HTTP Status Code
HTTP Status Code
- Definition Classes
- StatusCodes → StatusCodes
- case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable
Concrete representation of an
Endpoint
for routing purpose.Concrete representation of an
Endpoint
for routing purpose.- Definition Classes
- EndpointsWithCustomErrors
- case class EndpointWithHandler[A, B](endpoint: Endpoint[A, B], service: (A) => Future[B]) extends ToPlayHandler with Product with Serializable
An endpoint from which we can get a Play request handler.
An endpoint from which we can get a Play request handler.
- Definition Classes
- EndpointsWithCustomErrors
- trait Request[A] extends AnyRef
An HTTP request.
An HTTP request.
Has an instance of
InvariantFunctor
.- Definition Classes
- EndpointsWithCustomErrors
- trait ToPlayHandler extends AnyRef
Something that can be used as a Play request handler
Something that can be used as a Play request handler
- Definition Classes
- EndpointsWithCustomErrors
- trait UrlAndHeaders[A] extends AnyRef
The URL and HTTP headers of a request.
The URL and HTTP headers of a request.
- Definition Classes
- EndpointsWithCustomErrors
- case class Method(value: String) extends Product with Serializable
- Definition Classes
- Methods
- implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef
- Definition Classes
- Urls
- trait Path[A] extends EndpointsWithCustomErrors.Url[A]
- Definition Classes
- Urls
- trait QueryString[A] extends AnyRef
Query string encoding and decoding
Query string encoding and decoding
- Definition Classes
- Urls
- trait QueryStringParam[A] extends AnyRef
- Definition Classes
- Urls
- trait Segment[A] extends AnyRef
Defines how to decode and encode path segments
Defines how to decode and encode path segments
- Definition Classes
- Urls
- trait Url[A] extends AnyRef
- Definition Classes
- Urls
Abstract Value Members
- abstract val playComponents: PlayComponents
- Definition Classes
- EndpointsWithCustomErrors
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (Endpoints, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def Accepted: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- def BadRequest: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- Note
You should use the
badRequest
constructor provided by the endpoints.algebra.Responses trait to ensure that errors produced by endpoints are consistently handled by interpreters.
- def Created: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- def Delete: Method
- implicit def EmptyEndpointToPlayHandler[A, B](endpoint: Endpoint[A, B])(implicit ev: =:=[Unit, B]): ToPlayHandler
- Definition Classes
- EndpointsWithCustomErrors
- def Forbidden: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- def Get: Method
- def InternalServerError: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- Note
You should use the
internalServerError
constructor provided by the endpoints.algebra.Responses trait to ensure that errors produced by endpoints are consistently handled by interpreters.
- def NoContent: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- def NotFound: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- def NotImplemented: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- def OK: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- def Options: Method
- def Patch: Method
- def Post: Method
- def Put: Method
- def Unauthorized: play.api.mvc.Results.Status
- Definition Classes
- StatusCodes → StatusCodes
- implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]
- Definition Classes
- Urls
- 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
endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors
- implicit def booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a
Boolean
valueQuery string parameter containing a
Boolean
value- Definition Classes
- Urls
- def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
Chains the two paths
- 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
- EndpointsWithCustomErrors → Responses
- lazy val clientErrorsResponse: Response[ClientErrors]
Response used by the endpoints library when decoding a request fails.
Response used by the endpoints library when decoding a request fails.
The provided implementation forwards to
badRequest
.- Definition Classes
- Errors
- def clientErrorsResponseEntity: ResponseEntity[Invalid]
Response entity format for Invalid values
Response entity format for Invalid values
- Definition Classes
- BuiltInErrors → BuiltInErrors → Errors
- final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
Convert the ClientErrors type into the endpoints internal client error type
Convert the ClientErrors type into the endpoints internal client error type
- Definition Classes
- BuiltInErrors → Errors
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
Concatenates two
QueryString
s - 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]
Segment codec for type
Double
Segment codec for type
Double
- Definition Classes
- Urls
- implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
Implicit conversion to get rid of intellij errors when defining paths.
Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.
- Definition Classes
- Urls
- See also
- lazy val emptyRequest: BodyParser[Unit]
Empty request -- request without a body.
Empty request -- request without a body. Use
description
of endpoints.algebra.Endpoints#endpoint to document an empty body.- Definition Classes
- EndpointsWithCustomErrors → Requests
- lazy val emptyRequestHeaders: RequestHeaders[Unit]
Always succeeds in extracting no information from the headers
Always succeeds in extracting no information from the headers
- Definition Classes
- EndpointsWithCustomErrors → Requests
- def emptyResponse: ResponseEntity[Unit]
An empty response entity
An empty response entity
- Definition Classes
- EndpointsWithCustomErrors → Responses
- def emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header. Client interpreters should ignore information carried by response headers.
- Definition Classes
- EndpointsWithCustomErrors → Responses
- def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
HTTP endpoint.
HTTP endpoint.
- request
Request
- response
Response
- docs
Documentation (used by documentation interpreters)
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
- def ensuring(cond: (Endpoints) => Boolean, msg: => Any): Endpoints
- def ensuring(cond: (Endpoints) => Boolean): Endpoints
- def ensuring(cond: Boolean, msg: => Any): Endpoints
- def ensuring(cond: Boolean): Endpoints
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def extractMethodUrlAndHeaders[A, B](method: Method, url: Url[A], headers: RequestHeaders[B]): UrlAndHeaders[(A, B)]
- Attributes
- protected
- Definition Classes
- EndpointsWithCustomErrors
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- implicit lazy val functorRequestExtractor: Functor[RequestExtractor]
- Definition Classes
- Urls
- 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[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def handleClientErrors(invalid: Invalid): Result
This method is called by endpoints when decoding a request failed.
This method is called by endpoints when decoding a request failed.
The provided implementation calls
clientErrorsResponse
to construct a response containing the errors.This method can be overridden to customize the error reporting logic.
- Definition Classes
- Urls
- def handleServerError(throwable: Throwable): Result
This method is called by endpoints when an exception is thrown during request processing.
This method is called by endpoints when an exception is thrown during request processing.
The provided implementation calls serverErrorResponse to construct a response containing the error message.
This method can be overridden to customize the error reporting logic.
- Definition Classes
- EndpointsWithCustomErrors
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- lazy val htmlResponse: ResponseEntity[Html]
A successful HTTP response (status code 200) with an HTML entity
A successful HTTP response (status code 200) with an HTML entity
- Definition Classes
- EndpointsWithCustomErrors
- 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]
Ability to define
Int
path segmentsAbility to define
Int
path segments- 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
endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors
- final def invalidToClientErrors(invalid: Invalid): ClientErrors
Convert the endpoints internal client error type into the ClientErrors type
Convert the endpoints internal client error type into the ClientErrors type
- Definition Classes
- BuiltInErrors → Errors
- implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]
- Definition Classes
- EndpointsWithCustomErrors
- 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]
Segment containing a
Long
valueSegment containing a
Long
value- Definition Classes
- Urls
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- def optRequestHeader(name: String, docs: Option[String]): (Headers) => Validated[Option[String]]
An optional request header
An optional request header
- name
Header name (e.g., “Authorization”)
- Definition Classes
- EndpointsWithCustomErrors → Requests
- 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 asSome[String]
, orNone
if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.- Definition Classes
- EndpointsWithCustomErrors → Responses
- implicit def optionalQueryStringParam[A](implicit param: 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. Server interpreters must report a failure for incoming requests whose optional query string parameters are present, but malformed.
- 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
- implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
Provides
xmap
andxmapPartial
operations. - 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
- def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
Builds a
QueryString
with one parameter. - implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
Provides
xmap
andxmapPartial
operations. - implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
Provides
xmap
andxmapPartial
operations. - def redirect[A](other: => Endpoint[A, _])(args: A): Response[Unit]
- other
Endpoint to redirect to
- args
Arguments to pass to the endpoint to generate its URL
- returns
An HTTP response redirecting to another endpoint (using 303 code status).
- Definition Classes
- EndpointsWithCustomErrors
- def remainingSegments(name: String, docs: Documentation): Path[String]
The remaining segments of the path.
- implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: 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.
- def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
Decodes a request.
Decodes a request.
- method
Request method
- url
Request URL
- entity
Request entity
- docs
Request documentation
- headers
Request headers
- Definition Classes
- EndpointsWithCustomErrors → Requests
- implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- def requestHeader(name: String, docs: Option[String]): (Headers) => Validated[String]
A required request header
A required request header
- name
Header name (e.g., “Authorization”)
- Definition Classes
- EndpointsWithCustomErrors → Requests
- implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides
++
operation.Provides
++
operation.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
Server interpreters construct a response with the given status and entity.
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
- EndpointsWithCustomErrors → Responses
- implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
- Definition Classes
- EndpointsWithCustomErrors → Responses
- 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 asString
, 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
- EndpointsWithCustomErrors → Responses
- implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides
xmap
operation.Provides
xmap
operation.- Definition Classes
- EndpointsWithCustomErrors → Responses
- See also
- implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides
++
operation.Provides
++
operation.- Definition Classes
- EndpointsWithCustomErrors → Responses
- See also
- implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
Provides the operation
xmap
to the typeResponse
Provides the operation
xmap
to the typeResponse
- Definition Classes
- EndpointsWithCustomErrors → Responses
- See also
- def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]
Builds a Play router out of endpoint definitions.
Builds a Play router out of endpoint definitions.
val routes = routesFromEndpoints( inc.implementedBy(x => x + 1) )
- Definition Classes
- EndpointsWithCustomErrors
- def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
A path segment carrying an
A
information - implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
Provides
xmap
andxmapPartial
operations. - lazy val serverErrorResponse: Response[ServerError]
Response used by the endpoints library when the business logic of an endpoint fails.
Response used by the endpoints library when the business logic of an endpoint fails.
The provided implementation forwards to
internalServerError
- Definition Classes
- Errors
- def serverErrorResponseEntity: ResponseEntity[Throwable]
Response entity format for
Throwable
valuesResponse entity format for
Throwable
values- Definition Classes
- BuiltInErrors → BuiltInErrors → Errors
- final def serverErrorToThrowable(serverError: ServerError): Throwable
Convert the ServerError type into the endpoints internal server error type
Convert the ServerError type into the endpoints internal server error type
- Definition Classes
- BuiltInErrors → Errors
- def staticPathSegment(segment: String): Path[Unit]
A path segment whose value is the given
segment
- implicit lazy val stringQueryString: QueryStringParam[String]
Ability to define
String
query string parameters - implicit def stringSegment: Segment[String]
Ability to define
String
path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- lazy val textRequest: BodyParser[String]
Request with a
String
body.Request with a
String
body.- Definition Classes
- EndpointsWithCustomErrors → Requests
- def textResponse: ResponseEntity[String]
A text entity
A text entity
- Definition Classes
- EndpointsWithCustomErrors → Responses
- final def throwableToServerError(throwable: Throwable): ServerError
Convert the endpoints internal server error type into the ServerError type
Convert the endpoints internal server error type into the ServerError type
- Definition Classes
- BuiltInErrors → Errors
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
- Definition Classes
- Urls
- implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
Provides
xmap
andxmapPartial
operations - 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
- val utf8Name: String
- Definition Classes
- Urls
- 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]
Ability to define
UUID
path segmentsAbility to define
UUID
path segments- Definition Classes
- Urls
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- 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
Deprecated Value Members
- def →[B](y: B): (Endpoints, B)
- Implicit
- This member is added by an implicit conversion from Endpoints toArrowAssoc[Endpoints] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Inherited from BuiltInErrors
Inherited from EndpointsWithCustomErrors
Inherited from StatusCodes
Inherited from Methods
Inherited from Urls
Inherited from algebra.Endpoints
Inherited from algebra.BuiltInErrors
Inherited from algebra.EndpointsWithCustomErrors
Inherited from Errors
Inherited from Responses
Inherited from algebra.StatusCodes
Inherited from Requests
Inherited from endpoints.SemigroupalSyntax
Inherited from algebra.Methods
Inherited from algebra.Urls
Inherited from endpoints.PartialInvariantFunctorSyntax
Inherited from endpoints.InvariantFunctorSyntax
Inherited from AnyRef
Inherited from Any
Types
Types introduced by the algebra
Operations
Operations creating and transforming values