oas-forge 0.1.4

The zero-runtime OpenAPI 3.1 compiler for Rust. Extracts, links, and merges code-first documentation.
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Stores a reusable schema template with type parameters.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Blueprint {
    pub params: Vec<String>, // e.g. ["T", "U"] extracted from <T, U>
    pub body: String,
}

/// Stores a reusable fragment with optional parameters.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Fragment {
    pub params: Vec<String>,
    pub body: String,
}

/// Stores definitions for fragments, blueprints, and concrete schemas.
#[derive(Default, Debug)]
pub struct Registry {
    /// @openapi-fragment Name(arg1, arg2)
    pub fragments: HashMap<String, Fragment>,
    /// @openapi<T, U> -> key is Name ("Page")
    pub blueprints: HashMap<String, Blueprint>,
    /// Standard @openapi on structs
    pub schemas: HashMap<String, String>,
    /// Concrete schemas generated from generics (e.g. Page_User)
    pub concrete_schemas: HashMap<String, String>,
}

impl Registry {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn insert_fragment(&mut self, name: String, params: Vec<String>, content: String) {
        self.fragments.insert(
            name,
            Fragment {
                params,
                body: content,
            },
        );
    }

    pub fn insert_blueprint(&mut self, name: String, params: Vec<String>, content: String) {
        self.blueprints.insert(
            name,
            Blueprint {
                params,
                body: content,
            },
        );
    }

    pub fn insert_schema(&mut self, name: String, content: String) {
        self.schemas.insert(name, content);
    }
}