| Overview |  |
This is the main interface module
It provides basic functions for using libraryhttp_status() = non_neg_integer()
| capture_request/0 | |
| start_server/0 | Equivalent to start_server(32002). |
| start_server/1 | starts http server on a particular port. |
| stop_server/0 | stops http server. |
| stub_request/0 | Equivalent to stub_request(204, #{<<"Server">> => <<"BookishSpork/0.0.1">>, <<"Date">> => <<"Sat, 28 Apr 2018 05:51:50 GMT">>}, <<>>). |
| stub_request/1 | stub request with fun or particular status. |
| stub_request/2 | stub request with particular status and content/headers. |
| stub_request/3 |
capture_request() -> bookish_spork_request:bookish_spork_request()
start_server() -> {ok, pid()} | {error, Error::term()}
Equivalent to start_server(32002).
start_server(Port::non_neg_integer()) -> {ok, pid()} | {error, Error::term()}
starts http server on a particular port
stop_server() -> ok
stops http server
stub_request() -> ok
Equivalent to stub_request(204, #{<<"Server">> => <<"BookishSpork/0.0.1">>, <<"Date">> => <<"Sat, 28 Apr 2018 05:51:50 GMT">>}, <<>>).
stub_request(Fun::function() | http_status()) -> ok
stub request with fun or particular status
Fun must be fun((bookish_spork_request:request()) -> bookish_spork_response:response())
Example:
stub_request(fun(Request) ->
case bookish_spork_request:uri(Request) of
"/bookish/spork" ->
bookish_spork_response:new(200, <<"Hello">>);
"/admin/sporks" ->
bookish_spork_response:new(403, <<"It is not possible here">>)
end
end)
stub_request(Status::http_status(), ContentOrHeaders::binary() | map()) -> ok
stub request with particular status and content/headers
stub_request(Status::http_status(), Headers::map(), Content::binary()) -> ok
Generated by EDoc