JsonEntitiesFromSchemas

Extension methods for Endpoint.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Documentation related methods for annotating schemas. Encoder and decoder interpreters ignore this information.

Implicit methods for values of type JsonSchema

Convenient methods for Paths.

Given a parameter name and a query string content, returns a decoded parameter value of type T, or Invalid if decoding failed

Extension methods on QueryString.

Implicit methods for values of type Record

Extension methods for Request.

Extension methods for Response.

Callbacks indexed by URL pattern

Errors in a request built by a client

Error raised by the business logic of a server

Bad Request (400) response, with an entity of type ClientErrors.

Format of the response entity carrying the client errors.

Convert the ClientErrors type into the endpoints4s internal client error type

Default discriminator field name for sum types.

It defaults to "type", but you can override it twofold:

• by overriding this field you can change default discriminator name algebra-wide
• by using withDiscriminator you can specify discriminator field name for specific sum type

Helper method to perform DELETE request

Override this method to customize the behaviour of encoders produced by if(value.==(defaultValue))ujson.Obj.apply()elseujson.Obj.apply[Value](ArrowAssoc[String](name).->[Value](tpe.encoder.encode(value)))($conforms[Value]))else((`value₂`:A)=>ujson.Obj.apply[Value](ArrowAssoc[String](name).->[Value](tpe.encoder.encode(`value₂`)))($conforms[Value])) } (new$anon():Record[A]) }">optFieldWithDefault when encoding a field value that corresponds to the specified default value. By default, the default values are included.

As an example, consider the following Scala class and instances of it.

case class Book(
 name: String,
 availableAsEBook: Boolean = false
)

val book1 = Book("Complete Imaginary Works", false)
val book2 = Book("History of Writing", true)

With encodersSkipDefaultValues = false (which is the default), the field is always encoded, regardless of whether it is also the default value. This makes encoding performance predictable, but results in larger and more complicated encoded payloads:

{ "name": "Complete Imaginary Works", "availableAsEBook": false }
{ "name": "History of Writing", "availableAsEBook": true }

With encodersSkipDefaultValues = true, the field is skipped if its value if also the field's default value. This means encoding can be slower (since potentially expensive equality check needs to be performed), but the encoded payloads are smaller and simpler:

{ "name": "Complete Imaginary Works" }
{ "name": "History of Writing", "availableAsEBook": true }

Helper method to perform GET request

This method is called by endpoints4s when decoding a request failed.

The provided implementation calls clientErrorsResponse to complete with a response containing the errors.

This method can be overridden to customize the error reporting logic.

This method is called by ''endpoints'' when an exception is thrown during request processing.

The provided implementation uses serverErrorResponse to complete with a response containing the error message.

This method can be overridden to customize the error reporting logic.

Convenient constructor for enumerations represented by int values.

Internal Server Error (500) response, with an entity of type ServerError.

Convert the endpoints4s internal client error type into the ClientErrors type

Simpler alternative to Directive.&() method

A schema for a statically known value.

• Decoder interpreters first try to decode incoming values with the given tpe schema, and then check that it is equal to the given value,
• Encoder interpreters always produce the given value, encoded according to tpe,
• Documentation interpreters enrich the JSON schema with a const property documenting its only possible value (or an enum property with a single item).

This is useful to model schemas of objects containing extra fields that are absent from their Scala representation. For example, here is a schema for a GeoJSON point:

 case class Point(lon: Double, lat: Double)
 val pointSchema = (
   field("type")(literal("Point")) zip
   field[(Double, Double)]("coordinates")
 ).xmap(Point.tupled)(p => (p.lon, p.lat))

OK (200) Response with the given entity

The JSON schema of a coproduct that share the same parent type and thus can be widened to that parent type

Helper method to perform PATCH request

Helper method to perform POST request

Helper method to perform PUT request

Format of the response entity carrying the server error.

Convert the ServerError type into the endpoints4s internal server error type

Convenient constructor for enumerations represented by string values.

Convert the endpoints4s internal server error type into the ServerError type

Turns a Response[A] into a Response[Option[A]].

Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).

Response used by endpoints4s when decoding a request fails.

The provided implementation forwards to badRequest.

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")

Response used by endpoints4s when the business logic of an endpoint fails.

The provided implementation forwards to internalServerError

Extension methods for Endpoint.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Implicit methods for values of type JsonSchema

Convenient methods for Paths.

Extension methods on QueryString.

Implicit methods for values of type Record

Extension methods for Request.

Extension methods for Response.

Query string parameter containing a Boolean value

A JSON schema for type String

Codec for query string parameters of type Double

Path segment codec for type Double

An ISO 8601 duration

An ISO 8601 date-time in UTC

Ability to define Int query string parameters

Path segment codec for type Int

Query string parameter containing a Long value

Path segment codec for type Long

An ISO8601 date-time