The Faraday Adapter interface determines how a Faraday request is turned into a Faraday response object. Adapters are typically implemented with common Ruby HTTP clients, but can have custom implementations. Adapters can be configured either globally or per Faraday Connection through the configuration block.

For example, consider using httpclient as an adapter. Note that faraday-httpclient must be installed beforehand.

If you wants to configure it globally, do the following:

require 'faraday'
require 'faraday/httpclient'

Faraday.default_adapter = :httpclient

If you want to configure it per Faraday Connection, do the following:

require 'faraday'
require 'faraday/httpclient'

conn = Faraday.new do |f|
  f.adapter :httpclient
end

Fantastic adapters and where to find them

With the only exception being the Test Adapter, which is for test purposes only, adapters are distributed separately from Faraday. They are usually available as gems, or bundled with HTTP clients.

While most adapters use a common Ruby HTTP client library, adapters can also have completely custom implementations.

If you’re just getting started you can find a list of featured adapters in Awesome Faraday. Anyone can create a Faraday adapter and distribute it. If you’re interested learning more, check how to build your own!

Ad-hoc adapters customization

Faraday is intended to be a generic interface between your code and the adapter. However, sometimes you need to access a feature specific to one of the adapters that is not covered in Faraday’s interface. When that happens, you can pass a block when specifying the adapter to customize it. The block parameter will change based on the adapter you’re using. See each adapter page for more details.