Wrapper around reqwest to allow for client middleware chains.
Go to file
Robert Collins 07d154cadf
Custom otel names (#65)
* Breaking change(macros): require explicit name for tracing middleware

Closes: #52

This is suggested by the Opentelemetry spec, which requires "Therefore,
HTTP client spans SHOULD be using conservative, low cardinality names
formed from the available parameters of an HTTP request, such as "HTTP
{METHOD_NAME}". Instrumentation MUST NOT default to using URI path as
span name, but MAY provide hooks to allow custom logic to override the
default span name.
"

* Permit customisation of otel span names via OtelName
2022-11-07 13:07:23 +00:00
.cargo allow RUSTSEC-2020-0159 (#30) 2022-02-21 11:47:52 +00:00
.github Opentelemetry 0.18 (#58) 2022-09-20 16:07:32 +03:00
reqwest-middleware extensions middleware and request extensions (#56) 2022-09-30 10:14:31 +01:00
reqwest-retry Add note about streaming requests in RetryTransientMiddleware docs (#51) 2022-07-21 16:39:15 +01:00
reqwest-tracing Custom otel names (#65) 2022-11-07 13:07:23 +00:00
.gitignore Initial commit 2021-08-13 08:59:58 +01:00
CHANGELOG.md extensions middleware and request extensions (#56) 2022-09-30 10:14:31 +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 Allows adding properties to the span (#43) 2022-06-30 14:54:54 +01: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.