autapi 0.0.1

Automatic OpenAPI specification from function signatures
Documentation 
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
36
37
38
39
40
41
42
43
44

use serde::{Deserialize, Serialize};

use crate::openapi::macros::define_openapi_spec_object;

#[derive(PartialEq, Eq, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MaybeRef<T> {
    Ref(Ref),
    T(T),
}

impl<T> From<T> for MaybeRef<T> {
    fn from(value: T) -> Self {
        Self::T(value)
    }
}

define_openapi_spec_object! {
    pub struct Ref {
        #[serde(rename = "$ref")]
        pub target: String,
        pub summary: Option<String>,
        pub description: Option<String>,
    }
}

impl Ref {
    const PREFIX_SCHEMA_COMPONENTS_REF: &str = "#/components/schemas/";

    pub fn new(target: String) -> Ref {
        Self {
            target,
            description: Default::default(),
            summary: Default::default(),
        }
    }
    pub fn ref_schema_component(name: &str) -> Ref {
        Self::new(format!("{}{}", Self::PREFIX_SCHEMA_COMPONENTS_REF, name))
    }

    pub fn get_components_schema_name(&self) -> Option<&str> {
        self.target.strip_prefix(Self::PREFIX_SCHEMA_COMPONENTS_REF)
    }
}