sova-openapi 0.1.1

OpenAPI document generation and /docs UI for Sova
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use serde_json::Value;

/// Per-route OpenAPI annotations stored in route meta.
#[derive(Debug, Clone)]
pub struct Doc {
    pub(crate) skip: bool,
    pub(crate) body_schema: Option<Value>,
    pub(crate) query_schema: Option<Value>,
    pub(crate) params_schema: Option<Value>,
    pub(crate) responses: Vec<(u16, Value)>,
}

impl Doc {
    pub fn new() -> Self {
        Self {
            skip: false,
            body_schema: None,
            query_schema: None,
            params_schema: None,
            responses: Vec::new(),
        }
    }

    /// Mark the route as intentionally undocumented.
    pub fn skip() -> Self {
        Self {
            skip: true,
            ..Self::new()
        }
    }

    pub fn is_skip(&self) -> bool {
        self.skip
    }

    pub fn body_schema(mut self, schema: Value) -> Self {
        self.body_schema = Some(schema);
        self
    }

    pub fn query_schema(mut self, schema: Value) -> Self {
        self.query_schema = Some(schema);
        self
    }

    pub fn params_schema(mut self, schema: Value) -> Self {
        self.params_schema = Some(schema);
        self
    }

    pub fn ok_schema(mut self, schema: Value) -> Self {
        self.responses.push((200, schema));
        self
    }

    pub fn created_schema(mut self, schema: Value) -> Self {
        self.responses.push((201, schema));
        self
    }

    pub fn response(mut self, status: u16, schema: Value) -> Self {
        self.responses.push((status, schema));
        self
    }
}

impl Default for Doc {
    fn default() -> Self {
        Self::new()
    }
}