zio.http.endpoint

Describes the authentication type for an Endpoint.

When authentication fails at runtime, the endpoint responds with unauthorizedStatus, which defaults to Status.NotFound (404). This is an intentional security pattern (information hiding) that prevents attackers from discovering protected resources. To use a different status:

Endpoint(Method.GET / "secret")
 .auth(AuthType.Bearer)
 .unauthorizedStatus(Status.Unauthorized) // respond with 401 instead

An zio.http.endpoint.Endpoint represents an API endpoint for the HTTP protocol. Every API has an input, which comes from a combination of the HTTP route, query string parameters, and headers, and an output, which is the data computed by the handler of the API.

MiddlewareInput : Example: A subset of HttpCodec[Input] that doesn't give access to Input MiddlewareOutput: Example: A subset of Out[Output] that doesn't give access to Output Input: Example: Int Output: Example: User

As zio.http.endpoint.Endpoint is a purely declarative encoding of an endpoint, it is possible to use this model to generate a zio.http.Route (by supplying a handler for the endpoint), to generate OpenAPI documentation, to generate a type-safe Scala client for the endpoint, and possibly, to generate client libraries in other programming languages.

A zio.http.endpoint.EndpointExecutor is responsible for taking an endpoint invocation, and executing the invocation, returning the final result, or failing with a pre-defined RPC error.

An invocation represents a single invocation of an endpoint through provision of the input that the endpoint requires.

Invocations are pure data. In order to be useful, you must execute an invocation with an EndpointExecutor.

An endpoint locator is responsible for locating endpoints.