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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
use crate::adapters::http::{Request, RequestError};
#[cfg(feature = "validation-validator")]
use crate::adapters::http::response::format_validator_errors;
use serde::de::DeserializeOwned;
use validator::Validate;
pub trait ValidatorRequestValidation {
fn body_validator<T: DeserializeOwned + Validate>(
&self,
) -> Result<T, RequestError>;
fn query_validator<T: DeserializeOwned + Validate>(
&self,
) -> Result<Option<T>, RequestError>;
fn params_validator<T: DeserializeOwned + Validate>(
&self,
) -> Result<T, RequestError>;
}
impl ValidatorRequestValidation for Request {
/// Deserializes and validates the request body using validation rules.
///
/// This method combines JSON deserialization with validation using the
/// `validator` crate. It first deserializes the request body and then
/// runs validation rules defined on the target type.
///
/// ### Type Parameters
///
/// * `T` - The type to deserialize and validate (must implement `DeserializeOwned + Validate`)
///
/// ### Returns
///
/// Returns `Ok(T)` with the deserialized and validated instance, or
/// `Err(RequestError)` if there are deserialization or validation errors.
///
/// ### Errors
///
/// This function will return an error if:
/// - The request body is empty (`RequestError::BodyIsEmpty`)
/// - The JSON is invalid (`RequestError::ParseError`)
/// - The data fails validation rules (`RequestError::ValidationError`)
///
/// ### Example
///
/// ```rust,ignore
/// use sword::prelude::*;
/// use serde::Deserialize;
/// use validator::Validate;
///
/// #[derive(Deserialize, Validate)]
/// struct CreateUserRequest {
/// #[validate(length(min = 1, max = 50))]
/// name: String,
///
/// #[validate(email)]
/// email: String,
///
/// #[validate(range(min = 13, max = 120))]
/// age: u32,
/// }
///
/// ... asuming you have a controller struct ...
///
/// #[post("/users")]
/// async fn create_user(&self, req: Request) -> HttpResult {
/// let user_data: CreateUserRequest = req.body_validator()?;
///
/// // now data is guaranteed to be valid
///
/// Ok(JsonResponse::Ok().data(user_data))
/// }
/// ```
fn body_validator<T>(&self) -> Result<T, RequestError>
where
T: DeserializeOwned + Validate,
{
let body = self.body::<T>()?;
body.validate().map_err(|error| {
RequestError::validator_error(
"Invalid request body",
format_validator_errors(error),
)
})?;
Ok(body)
}
/// Deserializes and validates query parameters using validation rules.
///
/// This method combines query parameter parsing with validation using the
/// `validator` crate. It first deserializes the query string and then
/// runs validation rules defined on the target type.
///
/// Since query parameters are optional in HTTP, this method returns
/// `Option<T>` where `None` indicates no query parameters were present.
///
/// ### Type Parameters
///
/// * `T` - The type to deserialize and validate (must implement `DeserializeOwned + Validate`)
///
/// ### Returns
///
/// Returns:
/// - `Ok(Some(T))` with the deserialized and validated query parameters if they exist and are valid
/// - `Ok(None)` if no query parameters are present in the URL
/// - `Err(RequestError)` if query parameters exist but fail deserialization or validation
///
/// ### Errors
///
/// This function will return an error if:
/// - Query parameters cannot be parsed (`RequestError::ParseError`)
/// - The data fails validation rules (`RequestError::ValidationError`)
///
/// ### Example
///
/// ```rust,ignore
/// use sword::prelude::*;
/// use serde::Deserialize;
/// use validator::Validate;
///
/// #[derive(Deserialize, Validate, Default)]
/// struct SearchQuery {
/// #[validate(length(min = 1, max = 100))]
/// q: Option<String>,
///
/// #[validate(range(min = 1, max = 1000))]
/// page: Option<u32>,
///
/// #[validate(range(min = 1, max = 100))]
/// limit: Option<u32>,
/// }
///
/// ... asuming you have a controller struct ...
///
/// #[get("/search")]
/// async fn search(&self, req: Request) -> HttpResult {
/// let query: SearchQuery = req.query_validator()?.unwrap_or_default();
///
/// Ok(JsonResponse::Ok().data(query))
/// }
/// ```
fn query_validator<T>(&self) -> Result<Option<T>, RequestError>
where
T: DeserializeOwned + Validate,
{
match self.query::<T>()? {
Some(query) => {
query.validate().map_err(|error| {
RequestError::validator_error(
"Invalid request query",
format_validator_errors(error),
)
})?;
Ok(Some(query))
}
None => Ok(None),
}
}
/// Deserializes and validates path parameters using validation rules.
///
/// This method combines path parameter parsing with validation using the
/// `validator` crate. It first deserializes the path parameters and then
/// runs validation rules defined on the target type.
fn params_validator<T: DeserializeOwned + Validate>(
&self,
) -> Result<T, RequestError> {
let params = serde_json::to_value(self.params.clone()).map_err(|e| {
RequestError::parse_error("Failed to serialize params", e.to_string())
})?;
let deserialized: T = serde_json::from_value(params).map_err(|e| {
RequestError::parse_error(
"Failed to deserialize params to the target type",
e.to_string(),
)
})?;
deserialized.validate().map_err(|error| {
RequestError::validator_error(
"Invalid request params",
format_validator_errors(error),
)
})?;
Ok(deserialized)
}
}