murgamu 0.7.6

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

use super::schema::MurApiSchema;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum MurApiParameterIn {
	Query,
	Header,
	Path,
	Cookie,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MurApiParameter {
	pub name: String,
	#[serde(rename = "in")]
	pub location: MurApiParameterIn,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub description: Option<String>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub required: Option<bool>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub deprecated: Option<bool>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub schema: Option<MurApiSchema>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub example: Option<serde_json::Value>,
}

impl MurApiParameter {
	pub fn path(name: impl Into<String>, description: impl Into<String>) -> Self {
		Self {
			name: name.into(),
			location: MurApiParameterIn::Path,
			description: Some(description.into()),
			required: Some(true),
			deprecated: None,
			schema: Some(MurApiSchema::string()),
			example: None,
		}
	}

	pub fn query(name: impl Into<String>, description: impl Into<String>) -> Self {
		Self {
			name: name.into(),
			location: MurApiParameterIn::Query,
			description: Some(description.into()),
			required: None,
			deprecated: None,
			schema: Some(MurApiSchema::string()),
			example: None,
		}
	}

	pub fn header(name: impl Into<String>, description: impl Into<String>) -> Self {
		Self {
			name: name.into(),
			location: MurApiParameterIn::Header,
			description: Some(description.into()),
			required: None,
			deprecated: None,
			schema: Some(MurApiSchema::string()),
			example: None,
		}
	}

	pub fn cookie(name: impl Into<String>, description: impl Into<String>) -> Self {
		Self {
			name: name.into(),
			location: MurApiParameterIn::Cookie,
			description: Some(description.into()),
			required: None,
			deprecated: None,
			schema: Some(MurApiSchema::string()),
			example: None,
		}
	}

	pub fn required(mut self) -> Self {
		self.required = Some(true);
		self
	}

	pub fn optional(mut self) -> Self {
		self.required = Some(false);
		self
	}

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

	pub fn example(mut self, example: impl Into<serde_json::Value>) -> Self {
		self.example = Some(example.into());
		self
	}

	pub fn deprecated(mut self) -> Self {
		self.deprecated = Some(true);
		self
	}
}