ServerEndpoint

Error output parameter types (abbreviated as E).

Input parameter types (abbreviated as I).

Output parameter types (abbreviated as O).

The type of the value returned by the security logic, e.g. a user (abbreviated as U).

Security input parameter types (abbreviated as A).

Prepends additional security logic to this endpoint. This is useful when adding security to file/resource-serving endpoints. The additional security logic should return a Right(()) to indicate success, or a Left(E2) to indicate failure; in this case, the given error output will be used to create the response.

The security inputs will become a tuple, containing first additionalSecurityInput combined with the current endpoint.securityInput.

The error output will consist of two variants: either the securityErrorOutput (the ClassTag requirement for E2 is used to create the oneOfVariant). In the absence of sum types, the resulting errors are typed as Any.

The security logic is modified so that first additionalSecurityLogic is run, followed by the security logic defined so far.

The type of the value returned by the combined security logic, or the regular logic remains unchanged.

Prepends an additional input to this endpoint. This is useful when adding a context path to endpoints, e.g. serverEndpoint.prependSecurityIn("api" / "v1").

The given input can't map to any values in the request, hence its type is EndpointInput[Unit]; it has to be "netural" so that the server logic function can remain unchanged.

The input is prepended to the security inputs, so that it is decoded before any other path-related inputs (either security or regular).

See prependSecurity.

The method defined in a fixed method input in this endpoint, if any (using e.g. EndpointInputsOps.get or EndpointInputsOps.post).

Basic information about the endpoint, excluding mapping information, with inputs sorted (first the method, then path, etc.). E.g.: POST /books /add {header Authorization} {body as application/json (UTF-8)} -> {body as text/plain (UTF-8)}/-

Detailed description of the endpoint, with inputs/outputs represented in the same order as originally defined, including mapping information. E.g.:

Endpoint(securityin: -, in: /books POST /add {body as application/json (UTF-8)} {header Authorization}, errout: {body as text/plain (UTF-8)}, out: -)

Shows endpoint path, by default all parametrised path and query components are replaced by {param_name} or {paramN}, e.g. for

endpoint.in("p1" / path[String] / query[String]("par2"))

returns /p1/{param1}?par2={par2}

Equivalent to .toString, shows the whole case class structure.

Shortened information about the endpoint. If the endpoint is named, returns the name, e.g. [my endpoint]. Otherwise, returns the string representation of the method (if any) and path, e.g. POST /books/add