endpoints.documented.algebra

JsonEntitiesFromCodec

trait JsonEntitiesFromCodec extends JsonEntities

Fixes both the JsonRequest and JsonResponse types to be Codec.

Source
JsonEntities.scala
Linear Supertypes
JsonEntities, Endpoints, Responses, Requests, Methods, Urls, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JsonEntitiesFromCodec
  2. JsonEntities
  3. Endpoints
  4. Responses
  5. Requests
  6. Methods
  7. Urls
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Endpoint[A, B]

    Information carried by an HTTP endpoint

    Information carried by an HTTP endpoint

    Definition Classes
    Endpoints
  2. abstract type JsonCodec[A]

    A JSON codec type class

  3. type JsonRequest[A] = Codec[String, A]

    Type class defining how to represent the A information as a JSON request entity

    Type class defining how to represent the A information as a JSON request entity

    Definition Classes
    JsonEntitiesFromCodecJsonEntities
  4. type JsonResponse[A] = Codec[String, A]

    Type class defining how to represent the A information as a JSON response entity

    Type class defining how to represent the A information as a JSON response entity

    Definition Classes
    JsonEntitiesFromCodecJsonEntities
  5. abstract type Method

    Definition Classes
    Methods
  6. abstract type Path[A] <: Url[A]

    An URL path carrying an A information

    An URL path carrying an A information

    Definition Classes
    Urls
  7. implicit class PathOps[A] extends AnyRef

    Convenient methods for Paths.

  8. abstract type QueryString[A]

    A query string carrying an A information

    A query string carrying an A information

    Definition Classes
    Urls
  9. implicit class QueryStringOps[A] extends AnyRef

    Provides convenient methods on QueryString.

  10. abstract type QueryStringParam[A]

    A single query string parameter carrying an A information.

    A single query string parameter carrying an A information.

    Definition Classes
    Urls
  11. abstract type Request[A]

    Information carried by a whole request (headers and entity)

    Information carried by a whole request (headers and entity)

    Definition Classes
    Requests
  12. abstract type RequestEntity[A]

    Information carried by request entity

    Information carried by request entity

    Definition Classes
    Requests
  13. abstract type RequestHeaders[A]

    Information carried by requests’ headers

    Information carried by requests’ headers

    Definition Classes
    Requests
  14. abstract type Response[A]

    Information carried by a response

    Information carried by a response

    Definition Classes
    Responses
  15. abstract type Segment[A]

    An URL path segment carrying an A information.

    An URL path segment carrying an A information.

    Definition Classes
    Urls
  16. abstract type Url[A]

    An URL carrying an A information

    An URL carrying an A information

    Definition Classes
    Urls

Abstract Value Members

  1. abstract def Delete: Method

    Definition Classes
    Methods
  2. abstract def Get: Method

    Definition Classes
    Methods
  3. abstract def Patch: Method

    Definition Classes
    Methods
  4. abstract def Post: Method

    Definition Classes
    Methods
  5. abstract def Put: Method

    Definition Classes
    Methods
  6. abstract def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Chains the two paths

    Chains the two paths

    Definition Classes
    Urls
  7. abstract def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    Urls
  8. abstract def emptyHeaders: RequestHeaders[Unit]

    No particular information.

    No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.

    Definition Classes
    Requests
  9. abstract def emptyRequest: RequestEntity[Unit]

    Empty request.

    Empty request.

    Definition Classes
    Requests
  10. abstract def emptyResponse(documentation: String): Response[Unit]

    Empty response.

    Empty response.

    Definition Classes
    Responses
  11. abstract def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

    HTTP endpoint.

    HTTP endpoint.

    request

    Request

    response

    Response

    Definition Classes
    Endpoints
  12. implicit abstract def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

    Definition Classes
    Urls
  13. implicit abstract def intSegment: Segment[Int]

    Ability to define Int path segments

    Ability to define Int path segments

    Definition Classes
    Urls
  14. implicit abstract def jsonCodec[A](implicit arg0: JsonCodec[A]): Codec[String, A]

    Turns a JsonCodec[A] into a Codec[String, A]

  15. abstract def jsonRequest[A](documentation: Option[String] = None)(implicit arg0: JsonRequest[A]): RequestEntity[A]

    Defines a RequestEntity[A] given an implicit JsonRequest[A]

    Defines a RequestEntity[A] given an implicit JsonRequest[A]

    Definition Classes
    JsonEntities
  16. abstract def jsonResponse[A](documentation: String)(implicit arg0: JsonResponse[A]): Response[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Definition Classes
    JsonEntities
  17. implicit abstract def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

    Definition Classes
    Urls
  18. implicit abstract def longSegment: Segment[Long]

    Segment containing a Long value

    Segment containing a Long value

    Definition Classes
    Urls
  19. abstract def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

    Builds a QueryString with one optional parameter of type A.

    Builds a QueryString with one optional parameter of type A.

    name

    Parameter’s name

    Definition Classes
    Urls
  20. abstract def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

    Builds a QueryString with one parameter.

    Builds a QueryString with one parameter.

    A

    Type of the value carried by the parameter

    name

    Parameter’s name

    Definition Classes
    Urls
  21. abstract def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

    Request for given parameters

    Request for given parameters

    method

    Request method

    url

    Request URL

    Definition Classes
    Requests
  22. abstract def segment[A](name: String)(implicit s: Segment[A]): Path[A]

    Builds a path segment carrying an A information

    Builds a path segment carrying an A information

    name

    Name for the segment (for documentation)

    Definition Classes
    Urls
  23. abstract def staticPathSegment(segment: String): Path[Unit]

    Builds a static path segment

    Builds a static path segment

    Definition Classes
    Urls
  24. implicit abstract def stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    Urls
  25. implicit abstract def stringSegment: Segment[String]

    Ability to define String path segments

    Ability to define String path segments

    Definition Classes
    Urls
  26. abstract def textResponse(documentation: String): Response[String]

    Text response.

    Text response.

    Definition Classes
    Responses
  27. abstract 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

    Builds an URL from the given path and query string

    Definition Classes
    Urls

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def get[A, B](url: Url[A], headers: RequestHeaders[B] = emptyHeaders)(implicit tuplerAC: Tupler[A, B]): Request[Out]

    Helper method to perform GET request

    Helper method to perform GET request

    Definition Classes
    Requests
  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. val path: Path[Unit]

    An empty path.

    An empty path.

    Useful to begin a path definition:

    path / "foo" / segment[Int]("some-value")
    Definition Classes
    Urls
  19. final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

    Helper method to perform POST request

    Helper method to perform POST request

    Definition Classes
    Requests
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from JsonEntities

Inherited from Endpoints

Inherited from Responses

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from AnyRef

Inherited from Any

Ungrouped