Struct Route 

pub struct Route {
    pub method: Method,
    pub pattern: String,
    pub name: Option<String>,
    pub summary: Option<String>,
    pub tag: Option<String>,
    pub responses: Vec<(u16, String)>,
    pub parameters: Vec<(String, String)>,
    pub deprecated: bool,
    /* private fields */
}

Fields

method: Method

pattern: String

The pattern as written, used for route:list and metrics labels.

name: Option<String>

summary: Option<String>

What this route does, in one line. Feeds generated API documentation.

tag: Option<String>

A grouping label, so generated docs are not one flat list.

responses: Vec<(u16, String)>

Documented responses: status, and what it means.

parameters: Vec<(String, String)>

Documented parameters: name, and what it is.

deprecated: bool

Implementations

impl Route

pub fn parameter_names(&self) -> Vec<String>

The parameter names this route captures, in order.

Generated documentation needs these even when the author documented none, because a path parameter is required whether or not it is described.