mirror of
https://github.com/TrueLayer/reqwest-middleware.git
synced 2024-12-28 12:41:05 -08:00
88d2743ee1
* Update version number in example to 0.6 * Update README.md * Update README.md --------- Co-authored-by: Ethan Brierley <ethanboxx@gmail.com>
91 lines
3.9 KiB
Markdown
91 lines
3.9 KiB
Markdown
# reqwest-middleware
|
|
|
|
A crate implementing a wrapper around [reqwest](https://crates.io/crates/reqwest)
|
|
to allow for client middleware chains.
|
|
|
|
[](https://crates.io/crates/reqwest-middleware)
|
|
[](https://docs.rs/reqwest-middleware)
|
|
[](https://github.com/TrueLayer/reqwest-middleware/actions)
|
|
[](https://coveralls.io/github/TrueLayer/reqwest-middleware?branch=main)
|
|
|
|
This crate provides functionality for building and running middleware but no middleware
|
|
implementations. This repository also contains a couple of useful concrete middleware crates:
|
|
|
|
* [`reqwest-retry`](https://crates.io/crates/reqwest-retry): retry failed requests.
|
|
* [`reqwest-tracing`](https://crates.io/crates/reqwest-tracing):
|
|
[`tracing`](https://crates.io/crates/tracing) integration, optional opentelemetry support.
|
|
|
|
Note about browser support: automated tests targeting wasm are disabled. The crate may work with
|
|
wasm but wasm support is unmaintained. PRs improving wasm are still welcome but you'd need to
|
|
reintroduce the tests and get them passing before we'd merge it (see
|
|
https://github.com/TrueLayer/reqwest-middleware/pull/105).
|
|
|
|
## Overview
|
|
|
|
The `reqwest-middleware` client exposes the same interface as a plain `reqwest` client, but
|
|
`ClientBuilder` exposes functionality to attach middleware:
|
|
|
|
```toml
|
|
# Cargo.toml
|
|
# ...
|
|
[dependencies]
|
|
reqwest = { version = "0.12", features = ["rustls-tls"] }
|
|
reqwest-middleware = "0.4"
|
|
reqwest-retry = "0.7"
|
|
reqwest-tracing = "0.5"
|
|
tokio = { version = "1.0", features = ["macros", "rt-multi-thread"] }
|
|
```
|
|
|
|
```rust
|
|
use reqwest_middleware::{ClientBuilder, ClientWithMiddleware};
|
|
use reqwest_retry::{RetryTransientMiddleware, policies::ExponentialBackoff};
|
|
use reqwest_tracing::TracingMiddleware;
|
|
|
|
#[tokio::main]
|
|
async fn main() {
|
|
// Retry up to 3 times with increasing intervals between attempts.
|
|
let retry_policy = ExponentialBackoff::builder().build_with_max_retries(3);
|
|
let client = ClientBuilder::new(reqwest::Client::new())
|
|
// Trace HTTP requests. See the tracing crate to make use of these traces.
|
|
.with(TracingMiddleware::default())
|
|
// Retry failed requests.
|
|
.with(RetryTransientMiddleware::new_with_policy(retry_policy))
|
|
.build();
|
|
run(client).await;
|
|
}
|
|
|
|
async fn run(client: ClientWithMiddleware) {
|
|
client
|
|
.get("https://truelayer.com")
|
|
.header("foo", "bar")
|
|
.send()
|
|
.await
|
|
.unwrap();
|
|
}
|
|
```
|
|
|
|
#### License
|
|
|
|
<sup>
|
|
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
|
|
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
|
|
</sup>
|
|
|
|
<br>
|
|
|
|
<sub>
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
|
|
dual licensed as above, without any additional terms or conditions.
|
|
</sub>
|
|
|
|
## Third-party middleware
|
|
|
|
The following third-party middleware use `reqwest-middleware`:
|
|
|
|
- [`reqwest-conditional-middleware`](https://github.com/oxidecomputer/reqwest-conditional-middleware) - Per-request basis middleware
|
|
- [`http-cache`](https://github.com/06chaynes/http-cache) - HTTP caching rules
|
|
- [`reqwest-cache`](https://gitlab.com/famedly/company/backend/libraries/reqwest-cache) - HTTP caching
|
|
- [`aliri_reqwest`](https://github.com/neoeinstein/aliri/tree/main/aliri_reqwest) - Background token management and renewal
|
|
- [`http-signature-normalization-reqwest`](https://crates.io/crates/http-signature-normalization-reqwest) (not free software) - HTTP Signatures
|
|
- [`reqwest-chain`](https://github.com/tommilligan/reqwest-chain) - Apply custom criteria to any reqwest response, deciding when and how to retry.
|