Struct VersionedRouter 

pub struct VersionedRouter<S = ()>
where
    S: Clone + Send + Sync + 'static,
{
    pub version_routers: HashMap<String, Router<S>>,
    pub versioning_config: VersioningConfig,
    pub global_router: Option<Router<S>>,
    pub base_path: String,
}

Versioned router that handles multiple API versions

Fields

version_routers: HashMap<String, Router<S>>

Version-specific routers

versioning_config: VersioningConfig

Versioning configuration

global_router: Option<Router<S>>

Global router for non-versioned routes

base_path: String

Base API path (e.g., “/api”)

Implementations

impl<S> VersionedRouter<S>

where S: Clone + Send + Sync + 'static,

pub fn new() -> Self

Create a new versioned router

pub fn version(self, version: &str, router: Router<S>) -> Self

Add a version with its router

pub fn deprecate_version( self, version: &str, message: Option<&str>, sunset_date: Option<&str>, ) -> Self

Mark a version as deprecated

pub fn default_version(self, version: &str) -> Self

Set default version

pub fn strategy(self, strategy: VersionStrategy) -> Self

Set versioning strategy

pub fn global(self, router: Router<S>) -> Self

Add global routes (not versioned)

pub fn build(self) -> Router<S>

Build the final router with versioning middleware

pub fn version_builder<'a>( &'a mut self, version: &str, ) -> VersionedRouteBuilder<'a, S>

Create a router builder for a specific version

Trait Implementations

impl<S> Debug for VersionedRouter<S>

where S: Clone + Send + Sync + 'static + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Default for VersionedRouter<S>

where S: Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.