Struct ApiVersionLayer

pub struct ApiVersionLayer<const N: usize, F> { /* private fields */ }

Axum middleware to rewrite a request such that a version prefix is added to the path. This is based on a set of API versions and an optional "x-api-version" custom HTTP header: if no such header is present, the highest version is used. Yet this only applies to requests the URIs of which pass a filter; others are not rewritten.

Notice that paths starting with a valid version prefix, e.g. "/v0", are not rewritten.

Examples

The middleware needs to be applied to the “root” router:

let app = Router::new()
    .route("/", get(ok_0))
    .route("/v0/test", get(ok_0))
    .route("/v1/test", get(ok_1))
    .route("/foo", get(ok_foo));

const API_VERSIONS: ApiVersions<2> = ApiVersions::new([0, 1]);

let mut app = ApiVersionLayer::new(API_VERSIONS, FooFilter).layer(app);

Implementations

impl<const N: usize, F> ApiVersionLayer<N, F>

pub fn new(versions: ApiVersions<N>, filter: F) -> Self

Create a new API version layer.

Trait Implementations

impl<const N: usize, F: Clone> Clone for ApiVersionLayer<N, F>

fn clone(&self) -> ApiVersionLayer<N, F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const N: usize, S, F> Layer<S> for ApiVersionLayer<N, F>

where F: ApiVersionFilter,

type Service = ApiVersionService<N, S, F>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.