rocket_okapi 0.9.0

OpenAPI (AKA Swagger) document generation for Rocket applications
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Implement `OpenApiFromParam` for everything that implements `FromParam`
//! <https://docs.rs/rocket/latest/rocket/request/trait.FromParam.html#foreign-impls>

use super::OpenApiFromParam;
use crate::gen::OpenApiGenerator;
use okapi::openapi3::{Object, Parameter, ParameterValue};
use schemars::JsonSchema;

type Result = crate::Result<Parameter>;

impl<'r, T> OpenApiFromParam<'r> for T
where
    T: rocket::request::FromParam<'r> + JsonSchema,
{
    fn path_parameter(gen: &mut OpenApiGenerator, name: String) -> Result {
        let schema = gen.json_schema::<T>();
        Ok(Parameter {
            name,
            location: "path".to_owned(),
            description: None,
            required: true,
            deprecated: false,
            allow_empty_value: false,
            value: ParameterValue::Schema {
                style: None,
                explode: None,
                allow_reserved: false,
                schema,
                example: None,
                examples: None,
            },
            extensions: Object::default(),
        })
    }
}