Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dlesl/erqwest
An experimental erlang HTTP client wrapping reqwest
https://github.com/dlesl/erqwest
erlang http reqwest rust
Last synced: about 2 months ago
JSON representation
An experimental erlang HTTP client wrapping reqwest
- Host: GitHub
- URL: https://github.com/dlesl/erqwest
- Owner: dlesl
- Created: 2021-07-26T18:50:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-01T19:02:02.000Z (about 1 year ago)
- Last Synced: 2024-10-19T00:56:18.796Z (2 months ago)
- Topics: erlang, http, reqwest, rust
- Language: Erlang
- Homepage:
- Size: 919 KB
- Stars: 34
- Watchers: 3
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
erqwest
=======
[](https://hex.pm/packages/erqwest)
An erlang wrapper for [reqwest](https://github.com/seanmonstar/reqwest) using
[rustler](https://github.com/rusterlium/rustler). Map-based interface inspired
by [katipo](https://github.com/puzza007/katipo).
Features
--------
* HTTP/1.1 and HTTP/2 with connection keepalive/reuse
* Configurable SSL support, uses system root certificates by default
* Sync and async interfaces
* Proxy support
* Optional cookies support
* Optional gzip support
Prerequisites
-------------
* Erlang/OTP
* Rust
* OpenSSL (not required on mac)
Or use the provided `shell.nix` if you have nix installed.
Usage
---
### Start a client
``` erlang
ok = application:ensure_started(erqwest),
ok = erqwest:start_client(default).
```
This registers a client under the name `default`. The client maintains an
internal connection pool.
### Synchronous interface
#### No streaming
``` erlang
{ok, #{status := 200, body := Body}} =
erqwest:get(default, <<"https://httpbin.org/get">>),
{ok, #{status := 200, body := Body1}} =
erqwest:post(default, <<"https://httpbin.org/post">>,
#{body => <<"data">>}).
```
#### Stream request body
``` erlang
{handle, H} = erqwest:post(default, <<"https://httpbin.org/post">>,
#{body => stream}),
ok = erqwest:send(H, <<"data, ">>),
ok = erqwest:send(H, <<"more data.">>),
{ok, #{body := Body}} = erqwest:finish_send(H).
```
#### Stream response body
``` erlang
{ok, #{body := Handle}} = erqwest:get(default, <<"https://httpbin.org/stream-bytes/1000">>,
#{response_body => stream}),
ReadAll = fun Self() ->
case erqwest:read(Handle, #{length => 0}) of
{ok, Data} ->
[Data];
{more, Data} ->
[Data|Self()]
end
end,
1000 = iolist_size(ReadAll()).
```
#### Conditionally consume response body
``` erlang
{ok, Resp} = erqwest:get(default, <<"https://httpbin.org/status/200,500">>,
#{response_body => stream}),
case Resp of
#{status := 200, body := Handle} ->
{ok, <<>>} = erqwest:read(Handle),
#{status := BadStatus, body := Handle} ->
%% ensures the connection is closed/can be reused immediately
erqwest:cancel(Handle),
io:format("Status is ~p, not interested~n", [BadStatus])
end.
```
### Asynchronous interface
``` erlang
erqwest_async:req(default, self(), Ref=make_ref(),
#{method => get, url => <<"https://httpbin.org/get">>}),
receive
{erqwest_response, Ref, reply, #{body := Body}} -> Body
end.
```
See the [docs](https://hexdocs.pm/erqwest/) for more details and and the
[test suite](https://github.com/dlesl/erqwest/tree/master/test/erqwest_SUITE.erl)
for more examples.
[Docs](https://hexdocs.pm/erqwest/)
----
[Benchmarks](https://github.com/dlesl/erqwest/tree/master/bench)
-------------------