Skip to main content
Version: 2.x

Frequently Asked Questions

I'm New to ZIO! How Can I Get Started with ZIO HTTP?​

If you are new to ZIO, you can start by reading the ZIO documentation to understand the core concepts of ZIO. Once you are comfortable with ZIO, you can explore the ZIO HTTP documentation to learn how to build HTTP applications using ZIO. There are also several examples available in the ZIO HTTP repository that help you get started quickly.

What Libraries Does ZIO HTTP Rely On?​

ZIO HTTP is built on top of Netty for networking operations. It also leverages ZIO Core, ZIO Schema, and ZIO Stream for concurrency, encoding/decoding, and streaming, respectively.

I Love ZIO‌, But Don't Want to Use ZIO HTTP. What Alternatives Do I Have?​

If you prefer not to use ZIO HTTP but still want to build HTTP applications using ZIO, you can consider using Http4s, a functional HTTP library for Scala that can be integrated with ZIO effects (link). Additionally, if you are looking for a declarative approach to building HTTP applications, similar to ZIO HTTP's Endpoint API, you can explore Tapir. It's easy to integrate Tapir with ZIO using tapir-zio-http-server module.

How Can I Serialize/Deserialize Data to/from JSON in Requests and Responses?​

ZIO HTTP provides built-in support for JSON serialization and deserialization using ZIO Schema. You can derive JSON codecs for your custom data types using ZIO Schema and use them to encode/decode data to/from request/response bodies. Check out the BinaryCodecs section in the documentation for more details.

How Can I Handle CORS Requests in ZIO HTTP?​

ZIO has several middlewares including CORS that can be used to handle cross-origin resource sharing requests. Check out the Middleware section in the documentation for more details.

How Does ZIO HTTP Handle Errors?​

As a ZIO-based library, ZIO HTTP leverages ZIO's error-handling capabilities to handle errors in HTTP applications. You can use the ZIO#catch** methods to handle errors at various levels in your application. If you are not familiar with error handling in ZIO, we recommend reading the ZIO documentation.

Besides ZIO's error handling, ZIO HTTP has built-in support for handling errors. It has a notion of handled and unhandled errors at the HTTP layer. Let's say we have a Handler[-R, +Err, Request, Response], if the error channel is Response or a sub-type of it, it is considered as handled error, otherwise, it is considered as a handler with the unhandled error.

We have the same thing at the route level. Let's say we have a Routes[-Env, +Err], if the error channel is Response or a sub-type of it, it is considered as a collection of routes with all the errors handled, otherwise, it is considered as a collection of routes with unhandled errors. Before we can serve all routes, we should convert all unhandled errors to handled errors, using the Routes#handlerError method.

Is ZIO HTTP Suitable for Building High-performance HTTP Servers?​

Yes, ZIO HTTP is designed for performance, leveraging non-blocking I/O and asynchronous concurrency to handle high loads efficiently.

Can I integrate ZIO HTTP with Existing Scala/Java Libraries?​

Yes, ZIO HTTP provides interoperability with existing libraries, allowing you to leverage functionality from the Scala/Java ecosystem seamlessly by importing blocking and non-blocking operations.

Is ZIO HTTP Suitable for Building Microservices?​

Yes, ZIO HTTP along with the ZIO ecosystem is well-suited for building microservices, which provides many aspects that are essential for building cloud-native applications:

  • Configuration- ZIO has a built-in configuration system that allows you to manage different configurations for different environments. It also has ZIO Config that provides various config providers to load configurations from different sources, such as HOCON, JSON, YAML, and environment variables.
  • Logging and LogAnnotations- ZIO provides a structured logging system that allows you to log messages with different log levels. You can also use log annotations to add additional context to log messages which can be useful for debugging and tracing in distributed systems. We can use any of the backend logging supported by ZIO Logging, such as Log4j, Logback, and more.
  • Distributed Tracing- In microservice architectures, distributed tracing is essential for monitoring the flow of requests across different services. ZIO Telemetry supports distributed tracing using OpenTelemetry, OpenTracing, and OpenCensus.
  • Instrumenting Metrics- ZIO has built-in support for metrics instrumentation, with popular metrics backends such as Prometheus, Datadog, New Relic, and more.
  • Resilience to failures- When building microservices, it is essential to handle failures gracefully. There is a project called Rezilience that provides various resilience patterns such as retries, timeouts, circuit breakers, rate limiting, and more to build robust and resilient microservices.
  • Concurrency and Parallelism- ZIO provides a powerful concurrency model that allows you to write highly concurrent and parallel applications. With ZIO Fiber, and its Concurrency Primitives, you can write highly concurrent applications.
  • Resource-safety - ZIO provides a resource system that ensures resources are acquired and released safely. With ZIO Scopes and also scoped Layers, we can manage resources in a structured way.
  • ZIO Aspect and Middlewares- Both ZIO and ZIO HTTP support the idea of aspects and middlewares, which can be used to add cross-cutting concerns such as logging, metrics, authentication, and more to your services.
  • Modularity- With service pattern in ZIO, we can define our services along with their dependencies, and finally, we can start the service with its dependencies. This pattern is useful for building modular and testable services.