maxwell

v2.2.3

maxwell v2.2.3 Maxwell

The maxwell specification.

There are two kind of usages: basic usage and advanced middleware usage.

Basic Usage 

## Returns Origin IP, for example %{"origin" => "127.0.0.1"}
"http://httpbin.org/ip"
|> Maxwell.Conn.new()
|> Maxwell.get!()
|> Maxwell.Conn.get_resp_body()
|> Poison.decode!()

Find all get_*&put_* helper functions by h Maxwell.Conn.xxx

Advanced Middleware Usage(Create API Client). 

   defmodule Client do
     use Maxwell.Builder, ~w(get)a
     adapter Maxwell.Adapter.Ibrowse

     middleware Maxwell.Middleware.BaseUrl,   "http://httpbin.org"
     middleware Maxwell.Middleware.Opts,      [connect_timeout: 5000]
     middleware Maxwell.Middleware.Headers,   %{"User-Agent" => "zhongwencool"}
     middleware Maxwell.Middleware.Json

     ## Returns origin IP, for example "127.0.0.1"
     def ip() do
       "/ip"
       |> new()
       |> get!()
       |> get_resp_body("origin")
     end

     ## Generates n random bytes of binary data, accepts optional seed integer parameter
     def get_random_bytes(size) do
       "/bytes/#{size}"
       |> new()
       |> get!()
       |> get_resp_body(&to_string/1)
     end
  end

Link to this section Summary

Functions

delete!(conn \\ %Maxwell.Conn{})

DELETE! http method

delete!(conn, normal_statuses)

DELETE! http method

delete(conn \\ %Maxwell.Conn{})

DELETE method

get!(conn \\ %Maxwell.Conn{})

GET! http method without request body

get!(conn, normal_statuses)

GET! http method without request body

get(conn \\ %Maxwell.Conn{})

GET http method without request body

head!(conn \\ %Maxwell.Conn{})

HEAD! http method without request body

head!(conn, normal_statuses)

HEAD! http method without request body

head(conn \\ %Maxwell.Conn{})

HEAD http method without request body

options!(conn \\ %Maxwell.Conn{})

OPTIONS! http method without request body

options!(conn, normal_statuses)

OPTIONS! http method without request body

options(conn \\ %Maxwell.Conn{})

OPTIONS http method without request body

patch!(conn \\ %Maxwell.Conn{})

PATCH! http method

patch!(conn, normal_statuses)

PATCH! http method

patch(conn \\ %Maxwell.Conn{})

PATCH method

post!(conn \\ %Maxwell.Conn{})

POST! http method

post!(conn, normal_statuses)

POST! http method

post(conn \\ %Maxwell.Conn{})

POST method

put!(conn \\ %Maxwell.Conn{})

PUT! http method

put!(conn, normal_statuses)

PUT! http method

put(conn \\ %Maxwell.Conn{})

PUT method

trace!(conn \\ %Maxwell.Conn{})

TRACE! http method without request body

trace!(conn, normal_statuses)

TRACE! http method without request body

trace(conn \\ %Maxwell.Conn{})

TRACE http method without request body

Link to this section Functions

Link to this function delete!(conn \\ %Maxwell.Conn{})

DELETE! http method.

Return %Maxwell.Conn{} or raise %Maxwell.Error{} when status not in [200.299]

Link to this function delete!(conn, normal_statuses)

DELETE! http method.

  • conn - see delete/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function delete(conn \\ %Maxwell.Conn{})

DELETE method.

  • conn - %Maxwell.Conn{}.

Returns {:ok, %Maxwell.Conn{}} or {:error, reason, %Maxwell.Conn{}}

Link to this function get!(conn \\ %Maxwell.Conn{})

GET! http method without request body.

Returns %Maxwell.Conn{} or raise %MaxWell.Error{} when status not in [200..299].

Link to this function get!(conn, normal_statuses)

GET! http method without request body.

  • conn - see get/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function get(conn \\ %Maxwell.Conn{})

GET http method without request body.

  • conn - %Maxwell.Conn{}

Returns {:ok, %Maxwell.Conn{}} or {:error, reason_term, %Maxwell.Conn{}}.

Link to this function head!(conn \\ %Maxwell.Conn{})

HEAD! http method without request body.

Returns %Maxwell.Conn{} or raise %MaxWell.Error{} when status not in [200..299].

Link to this function head!(conn, normal_statuses)

HEAD! http method without request body.

  • conn - see head/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function head(conn \\ %Maxwell.Conn{})

HEAD http method without request body.

  • conn - %Maxwell.Conn{}

Returns {:ok, %Maxwell.Conn{}} or {:error, reason_term, %Maxwell.Conn{}}.

Link to this function options!(conn \\ %Maxwell.Conn{})

OPTIONS! http method without request body.

Returns %Maxwell.Conn{} or raise %MaxWell.Error{} when status not in [200..299].

Link to this function options!(conn, normal_statuses)

OPTIONS! http method without request body.

  • conn - see options/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function options(conn \\ %Maxwell.Conn{})

OPTIONS http method without request body.

  • conn - %Maxwell.Conn{}

Returns {:ok, %Maxwell.Conn{}} or {:error, reason_term, %Maxwell.Conn{}}.

Link to this function patch!(conn \\ %Maxwell.Conn{})

PATCH! http method.

Return %Maxwell.Conn{} or raise %Maxwell.Error{} when status not in [200.299]

Link to this function patch!(conn, normal_statuses)

PATCH! http method.

  • conn - see patch/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function patch(conn \\ %Maxwell.Conn{})

PATCH method.

  • conn - %Maxwell.Conn{}.

Returns {:ok, %Maxwell.Conn{}} or {:error, reason, %Maxwell.Conn{}}

Link to this function post!(conn \\ %Maxwell.Conn{})

POST! http method.

Return %Maxwell.Conn{} or raise %Maxwell.Error{} when status not in [200.299]

Link to this function post!(conn, normal_statuses)

POST! http method.

  • conn - see post/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function post(conn \\ %Maxwell.Conn{})

POST method.

  • conn - %Maxwell.Conn{}.

Returns {:ok, %Maxwell.Conn{}} or {:error, reason, %Maxwell.Conn{}}

Link to this function put!(conn \\ %Maxwell.Conn{})

PUT! http method.

Return %Maxwell.Conn{} or raise %Maxwell.Error{} when status not in [200.299]

Link to this function put!(conn, normal_statuses)

PUT! http method.

  • conn - see put/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function put(conn \\ %Maxwell.Conn{})

PUT method.

  • conn - %Maxwell.Conn{}.

Returns {:ok, %Maxwell.Conn{}} or {:error, reason, %Maxwell.Conn{}}

Link to this function trace!(conn \\ %Maxwell.Conn{})

TRACE! http method without request body.

Returns %Maxwell.Conn{} or raise %MaxWell.Error{} when status not in [200..299].

Link to this function trace!(conn, normal_statuses)

TRACE! http method without request body.

  • conn - see trace/1
  • normal_statuses - the specified status which not raise exception, for example: [200, 201]

Returns %Maxwell.Conn{} or raise %MaxWell.Error{}.

Link to this function trace(conn \\ %Maxwell.Conn{})

TRACE http method without request body.

  • conn - %Maxwell.Conn{}

Returns {:ok, %Maxwell.Conn{}} or {:error, reason_term, %Maxwell.Conn{}}.