Struct Router 

pub struct Router<S = ()> { /* private fields */ }

A drop-in replacement for axum::Router that adds OpenAPI documentation support.

This Router works seamlessly with handlers decorated with #[rovo] and provides a fluent API for building documented APIs with Swagger UI integration.

Example

use rovo::{Router, rovo, routing::get, aide::axum::IntoApiResponse};
use rovo::aide::openapi::OpenApi;
use rovo::response::Json;

#[rovo]
async fn documented_handler() -> impl IntoApiResponse {
    Json(())
}

let mut api = OpenApi::default();
api.info.title = "My API".to_string();

let app = Router::new()
    .route("/documented", get(documented_handler))
    .with_oas(api);

Implementations

impl<S> Router<S>

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

pub fn new() -> Self

Create a new Router

pub fn route<M>(self, path: &str, method_router: M) -> Self

where M: Into<ApiMethodRouter<S>>,

Add a route to the router

pub fn nest(self, path: &str, router: Self) -> Self

Nest another router at the given path

pub fn with_oas(self, api: OpenApi) -> Self

Configure OpenAPI spec with default routes (/api.json and /api.yaml)

This automatically sets up endpoints for both JSON and YAML formats.

pub fn with_oas_route(self, api: OpenApi, route: impl Into<String>) -> Self

Configure OpenAPI spec with custom base route

This sets up endpoints with the specified base route. For example, “/openapi” creates:

• /openapi.json
• /openapi.yaml

pub fn with_state(self, state: S) -> Router

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

Add state to the router and finalize the API

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

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

Finalize the API without state

pub fn finish_api(self, api: &mut OpenApi) -> Router<S>

Finish building the API and return an axum Router for further configuration

pub fn finish_api_with_extension(self, api: OpenApi) -> Router<S>

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

Finish the API with OpenAPI spec embedded via Extension layer

pub fn into_inner(self) -> AideApiRouter<S>

Convert into the underlying aide ApiRouter

Trait Implementations

impl<S> Default for Router<S>

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

fn default() -> Self

Returns the “default value” for a type.