Packages

•  package root

  Definition Classes

  root

•  package endpoints4s
  • algebras are in the algebra package,
  • interpreters are in the other packages (e.g., pekkohttp, http4s, openapi, etc.),
  • Types defined in this package are utility classes (e.g., Validated, Tupler).

  Definition Classes

  root

•  package generic

  Enriches algebras with operations performing generic derivation

  Enriches algebras with operations performing generic derivation

  Definition Classes

  endpoints4s

•  trait JsonSchemas extends algebra.JsonSchemas

  Enriches JsonSchemas with two kinds of operations:

  Enriches JsonSchemas with two kinds of operations:

  • genericJsonSchema[A] derives the JsonSchema of an algebraic data type A;
  • (field1 :×: field2 :×: …).as[A] builds a tuple of Records and maps it to a case class A

  For instance, consider the following program that derives the JSON schema of a case class:

  case class User(name: String, age: Int)
  object User {
    implicit val schema: JsonSchema[User] = genericJsonSchema[User]
  }

  It is equivalent to the following:

  case class User(name: String, age: Int)
  object User {
    implicit val schema: JsonSchema[User] = (
      field[String]("name") zip
      field[Int]("age")
    ).xmap((User.apply _).tupled)(Function.unlift(User.unapply))
  }

  Definition Classes

  generic

•  trait GenericDescriptions extends AnyRef

  Internal machinery for extracting a description of a type

  Internal machinery for extracting a description of a type

  Definition Classes

  JsonSchemas

• GenericDescription
• GenericDescriptionLowPriority

endpoints4s.generic.JsonSchemas.GenericDescriptions

GenericDescription

Companion class GenericDescription