Question 1

How do I upload files with Halite in Crystal?

Accepted Answer

Use the `form` argument with `File.open` to include files in POST requests, as shown in the README for single or multiple uploads. Halite handles multipart form data encoding automatically, making it straightforward for file-based integrations.

Question 2

Halite vs Crystal's HTTP::Client: which is better?

Accepted Answer

Halite is better for advanced needs like sessions, middleware, and a chainable API, while HTTP::Client is sufficient for simple, one-off requests with minimal overhead. Choose Halite for complex API clients and HTTP::Client for basic scripting.

Question 3

How to handle Bearer token authentication in Halite?

Accepted Answer

Use the `auth` method to set raw authorization headers, e.g., `Halite.auth("Bearer token").get(url)`. For other methods like Basic Auth, use `basic_auth` with username and password parameters.

Question 4

Can I implement custom logging middleware in Halite?

Accepted Answer

Yes, by creating a class that inherits from `Halite::Logging::Abstract` and implementing `request` and `response` methods. Then, register it or use it via the logging options, as detailed in the README's logging section.

Question 5

Is Halite good for high-performance API clients?

Accepted Answer

Halite leverages Crystal's performance but adds overhead with features like middleware. For maximum speed, tune or use simpler clients, but for most use cases, it's efficient enough with proper configuration like timeout settings.

Question 6

How to cache responses locally with Halite's middleware?

Accepted Answer

Enable the built-in local cache feature with `Halite.use("cache")`, which stores responses based on configurable paths and expiration times. Debug headers provide cache metadata, as explained in the README's local cache section.

Question 7

Does Halite support streaming for large downloads?

Accepted Answer

Yes, use streaming requests with a block to access `body_io` as an IO, allowing incremental processing of large responses. However, note that streaming always enables redirects and requires careful handling to avoid data loss.

halite

What is halite?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions