httpotion v3.1.0 HTTPotion View Source

The HTTP client for Elixir.

This module contains a basic general-purpose HTTP client. Everything in this module is created with use HTTPotion.Base. You can create your own customized client modules (see the README).

Link to this section Summary

Types

http_opts()

List of options to all request functions

http_result()

Result returned from request/3, get/2, post/2, put/2, etc

http_result_bang()

Result returned from request!/3, get!/2, post!/2, put!/2, etc

Functions

delete(url, options \\ [])

A shortcut for request(:delete, url, options)

delete!(url, options \\ [])

A shortcut for request!(:delete, url, options)

get(url, options \\ [])

A shortcut for request(:get, url, options)

get!(url, options \\ [])

A shortcut for request!(:get, url, options)

handle_response(response)

head(url, options \\ [])

A shortcut for request(:head, url, options)

head!(url, options \\ [])

A shortcut for request!(:head, url, options)

is_redirect(response)

options(url, options \\ [])

A shortcut for request(:options, url, options)

options!(url, options \\ [])

A shortcut for request!(:options, url, options)

patch(url, options \\ [])

A shortcut for request(:patch, url, options)

patch!(url, options \\ [])

A shortcut for request!(:patch, url, options)

post(url, options \\ [])

A shortcut for request(:post, url, options)

post!(url, options \\ [])

A shortcut for request!(:post, url, options)

process_options(options)

process_request_body(body)

process_request_headers(headers)

process_response_body(body)

process_response_body(headers, body)

process_response_chunk(body)

process_response_headers(headers)

process_response_location(response)

process_status_code(status_code)

process_url(url)

process_url(url, options)

put(url, options \\ [])

A shortcut for request(:put, url, options)

put!(url, options \\ [])

A shortcut for request!(:put, url, options)

redirect_method(response, method)

request(method, url, options \\ [])

Sends an HTTP request

request(method, url, body, headers, options)

request!(method, url, options \\ [])

Like request/3, but raises HTTPotion.HTTPError if failed

request_direct(conn_pid, method, url, body \\ "", headers \\ [], options \\ [])

response_ok(response)

spawn_link_worker_process(url, options \\ [])

Starts a linked worker process for use with the direct option

spawn_worker_process(url, options \\ [])

Starts a worker process for use with the direct option

start()

Ensures that HTTPotion and its dependencies are started

stop_worker_process(pid)

Stops a worker process started with spawn_worker_process/2 or spawn_link_worker_process/2

transformer(target, method, url, options)

Link to this section Types

http_opts()

http_opts() :: [
  body: binary() | charlist(),
  headers: [{atom() | String.Chars.t(), String.Chars.t()}],
  query: %{optional(String.Chars.t()) => String.Chars.t()},
  timeout: timeout(),
  basic_auth: {List.Chars.t(), List.Chars.t()},
  stream_to: pid() | port() | atom() | {atom(), node()},
  direct: pid() | port() | atom() | {atom(), node()},
  ibrowse: keyword(),
  auto_sni: boolean(),
  follow_redirects: boolean()
]

List of options to all request functions.

body - request body
headers - HTTP headers (e.g. ["Accept": "application/json"])
query - URL query string (e.g. %{page: 1})
timeout - timeout in milliseconds
basic_auth - basic auth credentials (e.g. {"user", "password"})
stream_to - if you want to make an async request, reference to the process
direct - if you want to use ibrowse’s direct feature, reference to the worker spawned by spawn_worker_process/2 or spawn_link_worker_process/2
ibrowse - options for ibrowse
auto_sni - if true and the URL is https, configures the server_name_indication ibrowse/ssl option to be the host part of the requestedURL
follow_redirects - if true and a response is a redirect, re-requests with header[:Location]

http_result()

http_result() ::
  HTTPotion.Response.t()
  | %HTTPotion.AsyncResponse{id: term()}
  | %HTTPotion.ErrorResponse{message: term()}

Result returned from request/3, get/2, post/2, put/2, etc.

http_result_bang()

http_result_bang() ::
  HTTPotion.Response.t() | %HTTPotion.AsyncResponse{id: term()}

Result returned from request!/3, get!/2, post!/2, put!/2, etc.

Link to this section Functions

delete(url, options \\ [])

delete(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:delete, url, options).

delete!(url, options \\ [])

delete!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:delete, url, options).

get(url, options \\ [])

get(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:get, url, options).

get!(url, options \\ [])

get!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:get, url, options).

handle_response(response)

head(url, options \\ [])

head(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:head, url, options).

head!(url, options \\ [])

head!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:head, url, options).

is_redirect(response)

options(url, options \\ [])

options(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:options, url, options).

options!(url, options \\ [])

options!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:options, url, options).

patch(url, options \\ [])

patch(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:patch, url, options).

patch!(url, options \\ [])

patch!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:patch, url, options).