zio.http.endpoint
Members list
Packages
Type members
Classlikes
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.
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.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Self type
-
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.
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.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
EndpointExecutor.type
An endpoint locator is responsible for locating endpoints.
An endpoint locator is responsible for locating endpoints.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
EndpointLocator.type
A description of endpoint middleware, in terms of what the middleware requires from the request, and what it appends to the response.
A description of endpoint middleware, in terms of what the middleware requires from the request, and what it appends to the response.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
- Self type
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
EndpointMiddleware.type
Attributes
- Supertypes
-
trait Producttrait Equalsclass Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
An invocation represents a single invocation of an endpoint through provision of the input that the endpoint requires.
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.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all