Type Members

1.  final class :>[path, postfix] extends DSLDef

   concatenates pair of paths into complete path

   concatenates pair of paths into complete path

   path

   prefix - always simple path without disjunctions

   postfix

   postfix

2.  final case class <|>[left, right](left: left, right: right) extends DSLDef with Product with Serializable

   disjunction operator can be used both for defining API type and for joining different handlers resulting type is effectively Either[left input, right input] => Either[left output, right output]

3.  final class AllQuery[name, x] extends DSLAtom

   return query params as Map[String, String]

4.  final class ApiKeyAuth[realm, Param <: CanHoldApiKey] extends DSLAtomAuth

   defines api key authentication scheme

   defines api key authentication scheme

   Param

   on of: Header, Cookie or Query

5.  final class As[directive, name] extends DSLAtom

   transforms directive to rename provided parameter with given name

6.  final class BasicAuth[realm, name, T] extends DSLAtomAuth

   defines basic authentication scheme

7.  final class BearerAuth[realm, name, T] extends DSLAtomAuth

   defines bearer authentication scheme

8.  trait CanHoldApiKey extends AnyRef
9.  final class Capture[name, x] extends DSLAtom

   captures param from path element

   captures param from path element

   name

   name of param, have no effect to routing

   x

   type of param, should have instance of FromPathParam

10.  final class Complete[x] extends DSLDef

    indicates result of element of type x does not check HTTP method

11.  final class Cookie[name, x] extends DSLAtom with CanHoldApiKey

    captures field value from Cookie

12.  trait DSLAtom extends DSLDef
13.  trait DSLAtomAuth extends DSLAtom
14.  trait DSLDef extends AnyRef
15.  trait DSLMethod extends DSLAtom
16.  final class Delete extends DSLMethod

    indicates result of element of type x via DELETE HTTP method

17.  final class FormField[name, x] extends DSLAtom

    captures field value from form data

    captures field value from form data

    name

    field name

    x

    parameter type, should have FromFormParam instance

18.  final class Get extends DSLMethod

    indicates result of element of type x via GET HTTP method

19.  class Group[key] extends AnyRef

    naming intermediate group of methods

20.  final class Head extends DSLMethod

    indicates result of element of type x via HEAD HTTP method

21.  final class Header[name, x] extends DSLAtom with CanHoldApiKey

    captures header value

    captures header value

    name

    header name

    x

    parameter type, should have FromHeader instance

22.  class Key[key] extends DSLAtom

    naming symbol of single route in complex route

23.  trait Meta extends DSLAtom

    Any path component that is subtype of Meta will be ignored by Serve but could support additional information like swagger tags or descriptions

24.  final class Options extends DSLMethod

    indicates result of element of type x via OPTIONS HTTP method

25.  final class Patch extends DSLAtom

    indicates result of element of type x via PATCH HTTP method

26.  final class Post extends DSLMethod

    indicates result of element of type x via POST HTTP method

27.  final class Prefix[pref] extends DSLAtom

    Indicated single path prefix Could be replaced by it's parameter

    Indicated single path prefix Could be replaced by it's parameter

    pref

    singleton string

28.  final class Put extends DSLMethod

    indicates result of element of type x via PUT HTTP method

29.  final class QueryFlag[name] extends DSLAtom

    captures fact of provision of param in query

    captures fact of provision of param in query

    name

    name of param

30.  final class QueryParam[name, x] extends DSLAtom with CanHoldApiKey

    captures param from query

    captures param from query

    name

    name of param

    x

    type of param, should have instance of FromQueryParam

31.  final class QueryParams[name, x] extends DSLAtom

    captures param list from query

    captures param list from query

    name

    name of param

    x

    type of param, should have instance of FromQueryParam

32.  final class Record[place[_, _], x] extends DSLAtom

    captures multiple fields from place

    captures multiple fields from place

    place

    Header, FormField, Cookie or QueryParam

    x

    record type - only simple types, with modifiers like Option or List accepted

33.  final class ReqBody[name, x] extends DSLAtom

    captures request body and unmarshalls in to requested type

    captures request body and unmarshalls in to requested type

    x

    type of body, should have FromRequestUnmarshaller instance

34.  class Tag[tag] extends Meta

    tagging symbol for route

35.  final class Transform[source, name, t, a, b] extends DSLAtom

    transforms existing parameter introducing new parameter using known transformation

36.  final class TransformReq[source, name, t, a, b, req] extends DSLAtom

    transforms existing parameter introducing new parameter using known transformation