typed-openrpc 0.1.1

Typed JSON-RPC 2.0 method definitions with OpenRPC document generation.
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
72
73
74
75
76
77
78
79
80

use serde_json::{json, Value};

use crate::{registry::Registry, rpc_method::MethodDoc};

/// Metadata describing the OpenRPC document.
#[derive(Clone, Debug)]
pub struct OpenRpcInfo {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
}

impl Default for OpenRpcInfo {
    fn default() -> Self {
        Self {
            title: "Generated API".to_string(),
            version: "1.0.0".to_string(),
            description: None,
        }
    }
}

impl OpenRpcInfo {
    fn to_value(&self) -> Value {
        let mut info = json!({
            "title": self.title,
            "version": self.version,
        });

        if let Some(description) = &self.description {
            info["description"] = json!(description);
        }

        info
    }
}

impl Registry {
    /// Convert all registered methods into an OpenRPC JSON document.
    pub fn generate_openrpc_doc(&self) -> Value {
        generate_openrpc_doc_with_info(self, &OpenRpcInfo::default())
    }

    pub fn generate_openrpc_doc_with_info(&self, info: &OpenRpcInfo) -> Value {
        generate_openrpc_doc_with_info(self, info)
    }
}

/// Convert all registered methods into an OpenRPC JSON document, using custom metadata.
fn generate_openrpc_doc_with_info(registry: &Registry, info: &OpenRpcInfo) -> Value {
    let methods = registry
        .methods()
        .iter()
        .map(method_to_value)
        .collect::<Vec<_>>();

    json!({
        "openrpc": "1.2.6",
        "info": info.to_value(),
        "methods": methods,
    })
}

fn method_to_value(method: &MethodDoc) -> Value {
    json!({
        "name": method.name.clone(),
        "summary": method.summary.clone(),
        "deprecated": method.deprecation.clone(),
        "tags": method.tags.clone(),
        "params": [{
            "name": "params",
            "schema": method.params_schema.clone(),
            "required": true,
        }],
        "result": {
            "name": "result",
            "schema": method.result_schema.clone(),
        }
    })
}