Specifies the API for using a custom HTTP Client.

The default HTTP client is FritzApi.HTTPClient.Finch.

To configure a different HTTP client, implement the FritzApi.HTTPClient behaviour and change the :client configuration:

config :fritz_api, :client, MyHTTPClient

Example

A client implementation based on :hackney could look like this:

defmodule MyHTTPClient do
  @behaviour FritzApi.HTTPClient

  @pool_name :my_http_client_pool

  @impl true
  def child_spec(pool_opts) do
    :hackney_pool.child_spec(@pool_name, pool_opts)
  end

  @impl true
  def get(url, req_opts) do
    opts = [:with_body, pool: @pool_name] ++ req_opts

    case :hackney.get(url, [], "", opts) do
      {:ok, _status, _headers, _body} = result -> result
      {:error, _reason} = error -> error
    end
  end
end