murgamu 0.7.4

A NestJS-inspired web framework for Rust
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use super::{
	components::MurApiComponents, contact::MurApiContact, external_doc::MurApiExternalDocs,
	info::MurApiInfo, license::MurApiLicense, path_item::MurApiPathItem, schema::MurApiSchema,
	security_scheme::MurApiSecurityScheme, server::MurApiServer, spec::MurOpenApiSpec,
	tag::MurApiTag,
};
use std::collections::HashMap;

pub struct MurOpenApi {
	spec: MurOpenApiSpec,
}

impl MurOpenApi {
	pub fn new(title: impl Into<String>, version: impl Into<String>) -> Self {
		Self {
			spec: MurOpenApiSpec {
				openapi: "3.0.3".to_string(),
				info: MurApiInfo {
					title: title.into(),
					version: version.into(),
					..Default::default()
				},
				..Default::default()
			},
		}
	}

	pub fn description(mut self, desc: impl Into<String>) -> Self {
		self.spec.info.description = Some(desc.into());
		self
	}

	pub fn terms_of_service(mut self, url: impl Into<String>) -> Self {
		self.spec.info.terms_of_service = Some(url.into());
		self
	}

	pub fn contact(mut self, name: impl Into<String>, email: impl Into<String>) -> Self {
		self.spec.info.contact = Some(MurApiContact {
			name: Some(name.into()),
			email: Some(email.into()),
			url: None,
		});
		self
	}

	pub fn contact_full(
		mut self,
		name: impl Into<String>,
		email: impl Into<String>,
		url: impl Into<String>,
	) -> Self {
		self.spec.info.contact = Some(MurApiContact {
			name: Some(name.into()),
			email: Some(email.into()),
			url: Some(url.into()),
		});
		self
	}

	pub fn license(mut self, name: impl Into<String>) -> Self {
		self.spec.info.license = Some(MurApiLicense {
			name: name.into(),
			url: None,
		});
		self
	}

	pub fn license_url(mut self, name: impl Into<String>, url: impl Into<String>) -> Self {
		self.spec.info.license = Some(MurApiLicense {
			name: name.into(),
			url: Some(url.into()),
		});
		self
	}

	pub fn server(mut self, url: impl Into<String>, description: impl Into<String>) -> Self {
		self.spec.servers.push(MurApiServer {
			url: url.into(),
			description: Some(description.into()),
			variables: HashMap::new(),
		});
		self
	}

	pub fn tag(mut self, name: impl Into<String>, description: impl Into<String>) -> Self {
		self.spec.tags.push(MurApiTag {
			name: name.into(),
			description: Some(description.into()),
			external_docs: None,
		});
		self
	}

	pub fn path<F>(mut self, path: impl Into<String>, builder: F) -> Self
	where
		F: FnOnce(MurApiPathItem) -> MurApiPathItem,
	{
		let path_item = builder(MurApiPathItem::default());
		self.spec.paths.insert(path.into(), path_item);
		self
	}

	pub fn path_item(mut self, path: impl Into<String>, item: MurApiPathItem) -> Self {
		self.spec.paths.insert(path.into(), item);
		self
	}

	pub fn schema(mut self, name: impl Into<String>, schema: MurApiSchema) -> Self {
		if self.spec.components.is_none() {
			self.spec.components = Some(MurApiComponents::default());
		}
		if let Some(ref mut components) = self.spec.components {
			components.schemas.insert(name.into(), schema);
		}
		self
	}

	pub fn security_scheme(
		mut self,
		name: impl Into<String>,
		scheme: MurApiSecurityScheme,
	) -> Self {
		if self.spec.components.is_none() {
			self.spec.components = Some(MurApiComponents::default());
		}
		if let Some(ref mut components) = self.spec.components {
			components.security_schemes.insert(name.into(), scheme);
		}
		self
	}

	pub fn bearer_auth(self) -> Self {
		self.security_scheme("bearerAuth", MurApiSecurityScheme::bearer())
	}

	pub fn api_key_auth(self, header_name: impl Into<String>) -> Self {
		self.security_scheme("apiKey", MurApiSecurityScheme::api_key_header(header_name))
	}

	pub fn basic_auth(self) -> Self {
		self.security_scheme("basicAuth", MurApiSecurityScheme::basic())
	}

	pub fn security(mut self, name: impl Into<String>, scopes: Vec<String>) -> Self {
		let mut req = HashMap::new();
		req.insert(name.into(), scopes);
		self.spec.security.push(req);
		self
	}

	pub fn external_docs(mut self, url: impl Into<String>, description: impl Into<String>) -> Self {
		self.spec.external_docs = Some(MurApiExternalDocs {
			url: url.into(),
			description: Some(description.into()),
		});
		self
	}

	pub fn build(self) -> MurOpenApiSpec {
		self.spec
	}

	pub fn to_json(&self) -> Result<String, serde_json::Error> {
		self.spec.to_json()
	}

	pub fn to_json_compact(&self) -> Result<String, serde_json::Error> {
		self.spec.to_json_compact()
	}
}