Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
124 lines (87 loc) · 2.46 KB

GETTING_STARTED.md

File metadata and controls

124 lines (87 loc) · 2.46 KB

Getting Started with hackney

This guide walks you through installing hackney and making your first HTTP requests.

Installation

Rebar3 (Erlang)

Add hackney to your rebar.config:

{deps, [hackney]}.

Mix (Elixir)

Add to your mix.exs:

{:hackney, "~> 4.0"}

Starting hackney

hackney is an OTP application. Start it before making requests:

application:ensure_all_started(hackney).

Your First Request

Simple GET

{ok, 200, Headers, Ref} = hackney:get(<<"https://httpbin.org/get">>).

Reading the Body

{ok, Body} = hackney:body(Ref).

One-Step Request with Body

Use with_body to get the body directly:

{ok, 200, Headers, Body} = hackney:get(URL, [], <<>>, [with_body]).

POST Requests

Simple POST

URL = <<"https://httpbin.org/post">>,
Headers = [{<<"content-type">>, <<"application/json">>}],
Body = <<"{\"name\": \"hackney\"}">>,
{ok, 200, _, Ref} = hackney:post(URL, Headers, Body).

Form Data

hackney:post(URL, [], {form, [{<<"key">>, <<"value">>}]}).

Multipart / File Upload

hackney:post(URL, [], {multipart, [
    {<<"field">>, <<"value">>},
    {file, <<"/path/to/file.txt">>}
]}).

Request Options

Option Description
with_body Return body in response tuple
{pool, Name} Use named connection pool
{pool, false} Don't use pooling
{connect_timeout, Ms} Connection timeout (default: 8000)
{recv_timeout, Ms} Response timeout (default: 5000)
async Receive response as messages
{follow_redirect, true} Follow redirects
insecure Skip SSL verification

Connection Pooling

hackney pools connections by default:

%% Create a pool
hackney_pool:start_pool(api_pool, [{max_connections, 50}]).

%% Use the pool
hackney:get(URL, [], <<>>, [{pool, api_pool}]).

%% Disable pooling
hackney:get(URL, [], <<>>, [{pool, false}]).

Error Handling

case hackney:get(URL) of
    {ok, Status, Headers, Ref} ->
        {ok, Body} = hackney:body(Ref);
    {error, timeout} ->
        handle_timeout();
    {error, Reason} ->
        handle_error(Reason)
end.

Next Steps