Struct Route 

pub struct Route { /* private fields */ }

Represents a route definition that can be registered with .mount()

Implementations

impl Route

pub fn new<H, T>(path: &'static str, method: &'static str, handler: H) -> Route

where H: Handler<T>, T: 'static,

Create a new route from a handler with path and method

pub fn summary(self, summary: impl Into<String>) -> Route

Set the operation summary

pub fn description(self, description: impl Into<String>) -> Route

Set the operation description

pub fn tag(self, tag: impl Into<String>) -> Route

Add a tag to the operation

pub fn path(&self) -> &str

Get the route path

pub fn method(&self) -> &str

Get the route method

pub fn param( self, name: impl Into<String>, schema_type: impl Into<String>, ) -> Route

Set a custom OpenAPI schema type for a path parameter

This is useful for overriding the auto-inferred type, e.g., when a parameter named id is actually a UUID instead of an integer.

Supported schema types

• "uuid" - String with UUID format
• "integer" or "int" - Integer with int64 format
• "string" - Plain string
• "boolean" or "bool" - Boolean
• "number" - Number (float)

Example

#[rustapi::get("/users/{id}")]
async fn get_user(Path(id): Path<Uuid>) -> Json<User> {
    // ...
}

// In route registration:
get_route("/users/{id}", get_user).param("id", "uuid")

pub fn param_schemas(&self) -> &HashMap<String, String>

Get the custom parameter schemas