Packages

package server

Server interpreters backed by Play framework

Source
package.scala
Linear Supertypes
Content Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. server
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package circe

Type Members

  1. trait Assets extends algebra.Assets with EndpointsWithCustomErrors

    Interpreter for algebra.Assets that performs routing using Play framework

  2. trait BasicAuthentication extends algebra.BasicAuthentication with EndpointsWithCustomErrors

  3. trait BuiltInErrors extends algebra.BuiltInErrors

  4. trait ChunkedEntities extends EndpointsWithCustomErrors with algebra.ChunkedEntities

    Interpreter for the algebra.ChunkedEntities algebra in the endpoints4s.play.server family.

  5. trait ChunkedJsonEntities extends ChunkedEntities with algebra.ChunkedJsonEntities with JsonEntitiesFromCodecs

    Interpreter for the algebra.ChunkedJsonEntities algebra in the endpoints4s.play.server family.

  6. 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.

    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)
  7. trait EndpointsWithCustomErrors extends algebra.EndpointsWithCustomErrors with Urls with Methods with StatusCodes

    Interpreter for algebra.Endpoints that performs routing using Play framework.

  8. trait JsonEntitiesFromCodecs extends algebra.JsonEntitiesFromCodecs with EndpointsWithCustomErrors

    Interpreter for algebra.JsonEntitiesFromCodecs that decodes JSON requests and encodes JSON responses.

  9. trait JsonEntitiesFromEncodersAndDecoders extends algebra.JsonEntities with EndpointsWithCustomErrors

    Interpreter for algebra.JsonEntities that decodes JSON entities with a endpoints4s.Decoder and encodes JSON entities with an endpoints4s.Encoder.

    Interpreter for algebra.JsonEntities that decodes JSON entities with a endpoints4s.Decoder and encodes JSON entities with an endpoints4s.Encoder.

    The difference with JsonEntitiesFromCodecs is that you don’t need bidirectional codecs: you only need an encoder to build responses, or a decoder to decode requests.

    It is especially useful to encode OpenApi documents into JSON entities.

  10. trait JsonEntitiesFromSchemas extends algebra.JsonEntitiesFromSchemas with JsonEntitiesFromCodecs with JsonSchemas

    Interpreter for algebra.JsonEntitiesFromSchemas that decodes JSON requests and encodes JSON responses.

  11. trait LowLevelEndpoints extends algebra.LowLevelEndpoints with Endpoints

  12. trait Methods extends algebra.Methods

    algebra.Methods interpreter that decodes and encodes methods.

  13. trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors

  14. trait MuxHandler[Req <: MuxRequest, Resp] extends AnyRef

    A function whose return type depends on the type of the given req.

    A function whose return type depends on the type of the given req.

    Req

    Request base type

    Resp

    Response base type

  15. trait MuxHandlerAsync[Req <: MuxRequest, Resp] extends AnyRef

    A function whose return type depends on the type of the given req.

    A function whose return type depends on the type of the given req.

    Req

    Request base type

    Resp

    Response base type

  16. trait PlayComponents extends AnyRef

    Play components needed by the interpreter

  17. trait StatusCodes extends algebra.StatusCodes

  18. trait Urls extends algebra.Urls

    algebra.Urls interpreter that decodes and encodes URLs.

Value Members

  1. object PlayComponents

Inherited from AnyRef

Inherited from Any

Interpreters

Ungrouped