axum-response-cache 0.3.0

Axum layer for caching HTTP responses of the wrapped server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

This library provides Axum middleware that caches HTTP responses to the
incoming requests based on their HTTP method and path.

The main struct is [`CacheLayer`](https://docs.rs/axum-response-cache/latest/axum_response_cache/struct.CacheLayer.html).
It can be created with any cache that implements two traits
from the [`cached`](https://crates.io/crates/cached) crate: `cached::Cached` and `cached::CloneCached`.

The *current* version of `CacheLayer` is compatible only with services accepting
Axum’s [`Request<Body>`](https://docs.rs/axum/latest/axum/extract/type.Request.html) and returning
[`axum::response::Response`](https://docs.rs/axum/latest/axum/response/type.Response.html),
thus it is not compatible with non-Axum [`tower`](https://crates.io/crates/tower) services.

It’s possible to configure the layer to re-use an old expired response in case the wrapped
service fails to produce a new successful response.

Only successful responses are cached (responses with status codes outside of the `[200-299]`
range are passed-through or ignored).

The cache limits maximum size of the response’s body (128 MB by default).

## Example

To cache a response over a specific route,
just wrap it in a [`CacheLayer`](https://docs.rs/axum-response-cache/latest/axum_response_cache/struct.CacheLayer.html):

```rust
use axum::{Router, extract::Path, routing::get};
use axum_response_cache::CacheLayer;

#[tokio::main]
async fn main() {
    let mut router = Router::new()
        .route(
            "/hello/{name}",
            get(|Path(name): Path<String>| async move { format!("Hello, {name}!") })
                // this will cache responses with each `{name}` for 60 seconds.
                .layer(CacheLayer::with_lifespan(60)),
        );

    let listener = tokio::net::TcpListener::bind("0.0.0.0:8080").await.unwrap();
    axum::serve(listener, router).await.unwrap();
}
```

For more see [the documentation](https://docs.rs/axum-response-cache/).