Packages

•  package root

  Definition Classes

  root

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

  Definition Classes

  root

•  package algebra

  Algebra interfaces

  Algebra interfaces

  Definition Classes

  endpoints4s

•  trait Urls extends PartialInvariantFunctorSyntax

  Algebra interface for describing URLs made of a path and a query string.

  Algebra interface for describing URLs made of a path and a query string.

  A path is itself made of segments chained together.

  A query string is made of named parameters.

  /**
    * Describes an URL starting with a segment containing “articles”, followed
    * by another `String` segment, and a query string containing
    * a mandatory `Lang` parameter named “lang”, and an
    * optional `Int` parameter named “page”.
    *
    * Examples of matching URLs:
    *
    * - /articles/kitchen?lang=fr
    * - /articles/garden?lang=en&page=2
    */
  val example = path / "articles" / segment[String]() /? (qs[Lang]("lang") & qs[Option[Int]]("page"))

  Definition Classes

  algebra

• InvariantFunctorSyntax
• PartialInvariantFunctorSyntax
• Path
• PathOps
• QueryString
• QueryStringParam
• QueryStringSyntax
• Segment
• Url

endpoints4s.algebra.Urls

QueryStringSyntax