Module api_router 

APIRouter for modular route organization.

This module provides APIRouter for grouping related routes with shared configuration like prefixes, tags, and dependencies.

Example

use fastapi_core::api_router::APIRouter;
use fastapi_core::{Request, Response, RequestContext};

async fn get_users(ctx: &RequestContext, req: &mut Request) -> Response {
    Response::ok().body_text("List of users")
}

async fn create_user(ctx: &RequestContext, req: &mut Request) -> Response {
    Response::ok().body_text("User created")
}

let router = APIRouter::new()
    .prefix("/api/v1/users")
    .tags(vec!["users"])
    .get("", get_users)
    .post("", create_user);

let app = App::builder()
    .include_router(router)
    .build();

Structs

APIRouter

Router for grouping related routes with shared configuration.

IncludeConfig

Configuration for including a router with overrides.

ResponseDef

Response definition for OpenAPI documentation.

RouterDependency

A shared dependency that runs before route handlers.

RouterRoute

Internal route storage that includes router-level metadata.

Type Aliases

BoxDependency

A boxed dependency function.