Struct VersionRouter 

pub struct VersionRouter { /* private fields */ }

Router for version-based API routing

This router manages different versions of your API and can:

• Route requests to the appropriate version handler
• Generate separate OpenAPI specs for each version
• Handle version deprecation and sunset

Implementations

impl VersionRouter

pub fn new() -> Self

Create a new version router

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

Set the versioning strategy

pub fn strategies(self, strategies: Vec<VersionStrategy>) -> Self

Add multiple strategies (tried in order)

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

Set the default version

pub fn fallback(self, behavior: VersionFallback) -> Self

Set the fallback behavior

pub fn version(self, version: ApiVersion, config: VersionedRouteConfig) -> Self

Register a version

pub fn version_with_spec_31( self, version: ApiVersion, config: VersionedRouteConfig, spec: OpenApi31Spec, ) -> Self

Register a version with OpenAPI 3.1 spec

pub fn version_with_spec_30( self, version: ApiVersion, config: VersionedRouteConfig, spec: OpenApiSpec, ) -> Self

Register a version with OpenAPI 3.0 spec

pub fn registered_versions(&self) -> Vec<ApiVersion>

Get all registered versions

pub fn latest_version(&self) -> Option<ApiVersion>

Get the latest registered version

pub fn resolve_from_path(&self, path: &str) -> ResolvedVersion

Resolve a version from a path

pub fn resolve_from_headers( &self, headers: &HashMap<String, String>, ) -> ResolvedVersion

Resolve a version from headers

pub fn resolve_from_query(&self, query: &str) -> ResolvedVersion

Resolve a version from query string

pub fn get_spec_31(&self, version: &ApiVersion) -> Option<&OpenApi31Spec>

Get OpenAPI 3.1 spec for a version

pub fn get_spec_30(&self, version: &ApiVersion) -> Option<&OpenApiSpec>

Get OpenAPI 3.0 spec for a version

pub fn strip_version(&self, path: &str) -> String

Strip version from path

pub fn is_deprecated(&self, version: &ApiVersion) -> bool

Check if a version is deprecated

pub fn get_deprecation_info( &self, version: &ApiVersion, ) -> Option<DeprecationInfo>

Get deprecation info for a version

Trait Implementations

impl Clone for VersionRouter

fn clone(&self) -> VersionRouter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionRouter

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

Formats the value using the given formatter.

impl Default for VersionRouter

fn default() -> Self

Returns the “default value” for a type.