Trait rocket_okapi::request::OpenApiFromParam

pub trait OpenApiFromParam<'r>: FromParam<'r> {
    fn path_parameter(
        gen: &mut OpenApiGenerator, 
        name: String
    ) -> Result<Parameter>;
}

This trait is used to document a dynamic part of a path that implements FromParam. For example <user_id> in route path.

Required Methods

fn path_parameter(gen: &mut OpenApiGenerator, name: String) -> Result<Parameter>

Return a Parameter containing the information required to document the FromParam path parameter.

Implementors

impl<'r, T> OpenApiFromParam<'r> for T where
    T: FromParam<'r> + JsonSchema,