Wrapper around reqwest to allow for client middleware chains.
Go to file
Rutger 594075583c
Added a way to specify custom functions which decide whether a request should be retried or not (#33)
* Add a generic function to the middleware struct for the `Retryable` decision.

The generic function can be used to define custom behaviour to decide whether to retry a request or not.

By default, this function is `Retryable::from_reqwest_response` which is the same as it was before.

* Add a way to create custom retry policies.

A RetryStrategy will dictate what decision will be made based on the result of the sent request.

* Add RetryableStrategy in the `RetryTransientMiddleware` struct instead of the seperate functions

* Add constructor to create a `RetryTransientMiddleware` with a custom `RetryableStrategy`

* Run `cargo fmt`

* Add example code to the `RetryableStrategy` struct

* Run `cargo fmt`

* Updated changelog

* use a trait

* docs

* include latest changes

Co-authored-by: Conrad Ludgate <conrad.ludgate@truelayer.com>
2023-05-22 11:53:31 +01:00
.cargo allow RUSTSEC-2020-0159 (#30) 2022-02-21 11:47:52 +00:00
.github feat: wasm32-unknown-unknown support (#79) 2023-03-09 11:33:13 +00:00
reqwest-middleware release middleware 2023-05-11 14:17:05 +01:00
reqwest-retry Added a way to specify custom functions which decide whether a request should be retried or not (#33) 2023-05-22 11:53:31 +01:00
reqwest-tracing add default_span_name helper function (#93) 2023-05-15 14:55:56 +01:00
.gitignore Initial commit 2021-08-13 08:59:58 +01:00
CHANGELOG.md Move path matching changes to right log (#91) 2023-05-12 11:16:42 +01:00
CODE_OF_CONDUCT.md Initial commit 2021-08-13 08:59:58 +01:00
CONTRIBUTING.md Initial commit 2021-08-13 08:59:58 +01:00
Cargo.toml Initial commit 2021-08-13 08:59:58 +01:00
LICENSE-APACHE Initial commit 2021-08-13 08:59:58 +01:00
LICENSE-MIT Initial commit 2021-08-13 08:59:58 +01:00
README.md README.md: Add third party middleware list (#75) 2022-11-23 11:20:21 +00:00

README.md

reqwest-middleware

A crate implementing a wrapper around reqwest to allow for client middleware chains.

Crates.io Docs.rs CI Coverage Status

This crate provides functionality for building and running middleware but no middleware implementations. This repository also contains a couple of useful concrete middleware crates:

Overview

The reqwest-middleware client exposes the same interface as a plain reqwest client, but ClientBuilder exposes functionality to attach middleware:

# Cargo.toml
# ...
[dependencies]
reqwest = "0.11"
reqwest-middleware = "0.1.6"
reqwest-retry = "0.1.5"
reqwest-tracing = "0.2.3"
tokio = { version = "1.12.0", features = ["macros", "rt-multi-thread"] }
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

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
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.

Third-party middleware

The following third-party middleware use request-middleware: