Struct APIRouter 

pub struct APIRouter<S = ()> {
    pub prefix: String,
    pub routes: Vec<Route<S>>,
}

A router for defining and organizing API routes.

APIRouter provides a fluent interface for registering HTTP route handlers with automatic OpenAPI documentation generation. Routes can be organized using path prefixes and routers can be combined using include_router().

Type Parameters

• S - The application state type

Examples

use fastrust::{APIRouter, RouteConfig};
use axum::extract::Path;

async fn hello(Path(name): Path<String>) -> String {
    format!("Hello {}", name)
}

let mut api = APIRouter::new("/api");
api.get("/hello/{name}", hello, RouteConfig::default().summary("Say hello"));

Path Prefixes

Routes registered with an APIRouter automatically have the router’s prefix prepended. For example, a router with prefix /api and a route /users will result in the full path /api/users.

Combining Routers

Routers can be combined using include_router():

use fastrust::APIRouter;

let mut api = APIRouter::new("/api");
let mut v1 = APIRouter::new("/v1");

v1.include_router(api); // Routes become /v1/api/...

Fields

prefix: String

The path prefix for all routes in this router.

routes: Vec<Route<S>>

The list of routes registered in this router.

Implementations

impl<S> APIRouter<S>

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

pub fn new(prefix: impl Into<String>) -> Self

Creates a new APIRouter with the given path prefix.

Arguments

• prefix - The path prefix for all routes (e.g., “/api”, “/v1”)

Examples

use fastrust::APIRouter;

let api = APIRouter::new("/api");
let v1 = APIRouter::new("/v1");

pub fn add_route(&mut self, route: Route<S>)

Adds a route directly to the router.

Arguments

• route - The route to add

pub fn include_router(&mut self, router: APIRouter<S>)

Includes all routes from another router into this one.

This method consumes the provided router and adds all its routes to this router, prepending this router’s prefix to each route’s path.

Arguments

• router - The router to include

Examples

use fastrust::APIRouter;

let mut api = APIRouter::new("/api");
let mut v1 = APIRouter::new("/v1");

v1.include_router(api); // api routes now have /v1 prefix

pub fn get<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn post<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn put<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn patch<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn delete<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn head<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn options<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn trace<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

pub fn connect<H, T>( &mut self, path: &str, handler: H, route_config: RouteConfig, ) -> &mut Self

where H: Handler<T, S>, T: InspectSignature + 'static,

Trait Implementations

impl<S: Clone> Clone for APIRouter<S>

fn clone(&self) -> APIRouter<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for APIRouter<S>

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

Formats the value using the given formatter.