cepex v0.1.0

Cepex.HTTP behaviour (cepex v0.1.0) View Source

This is the behaviour to implement HTTP clients to use with Cepex. The library has a built-in implementation of hackney (check Cepex.HTTP.Hackney).

Link to this section Summary

Types

header()
url()

Callbacks

get(url, headers)

Performs a GET HTTP request with the given parameters and returns a Cepex.HTTP.Response struct, when successful.

Link to this section Types

Link to this type

header()

View Source

Specs

header() :: {key :: String.t(), value :: String.t()}
Link to this type

url()

View Source

Specs

url() :: String.t()

Link to this section Callbacks

Link to this callback

get(url, headers)

View Source

Specs

get(url :: String.t(), headers :: [header()]) ::
  {:ok, Cepex.HTTP.Response.t()} | {:error, any()}

Performs a GET HTTP request with the given parameters and returns a Cepex.HTTP.Response struct, when successful.