sword 0.2.1

Structured web framework built on top of tokio ecosystem, providing powerful features for building robust web applications.
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

use crate::adapters::http::RequestError;

pub use axum_responses::{
    ContentDisposition, File, JsonResponse, JsonResponseBody, Redirect,
};

pub use sword_macros::HttpError;

pub type HttpResult<T = JsonResponse> = Result<T, JsonResponse>;

impl From<RequestError> for JsonResponse {
    fn from(error: RequestError) -> JsonResponse {
        match error {
            RequestError::ParseError { message, details } => {
                tracing::error!(details = ?details,  "Request parse error: {message}");
                JsonResponse::BadRequest().message(message).error(details)
            }
            #[cfg(feature = "validation-validator")]
            RequestError::ValidatorError { message, details } => {
                tracing::error!(details = ?details,  "Request validation error: {message}");
                JsonResponse::BadRequest().message(message).errors(details)
            }

            RequestError::BodyIsEmpty => {
                JsonResponse::BadRequest().message("Request body is empty")
            }
            RequestError::BodyTooLarge => JsonResponse::PayloadTooLarge().message(
                "The request body exceeds the maximum allowed size by the server",
            ),
            RequestError::UnsupportedMediaType { message } => {
                JsonResponse::UnsupportedMediaType().message(message)
            }
            RequestError::DeserializationError {
                message,
                error,
                source,
            } => {
                tracing::error!(source = %source, "Request deserialization error: {message}");
                JsonResponse::BadRequest().message(message).error(error)
            }
            RequestError::InvalidHeaderName(name) => {
                tracing::error!(header = %name, "Invalid header name");
                JsonResponse::BadRequest()
                    .message("Invalid header name")
                    .error(format!("Header '{name}' contains invalid characters"))
            }
            RequestError::InvalidHeaderValue(name) => {
                tracing::error!(header = %name, "Invalid header value");
                JsonResponse::BadRequest()
                    .message("Invalid header value")
                    .error(format!(
                        "Value for header '{name}' contains invalid characters",
                    ))
            }
            #[cfg(feature = "multipart")]
            RequestError::MultipartError(err) => {
                tracing::error!(error = %err, "Multipart error");
                JsonResponse::status(err.status()).message("Multipart error")
            }
            #[cfg(feature = "multipart")]
            RequestError::MultipartRejection(err) => {
                tracing::error!(error = %err, "Multipart rejection");
                JsonResponse::status(err.status()).message("Multipart rejection")
            }
        }
    }
}

#[cfg(feature = "validation-validator")]
/// Structured JSON output for validation errors  from the `validator` crate.
///
/// # Example
///
/// ```json
/// {
///   "email": [
///     {
///       "code": "invalid",
///       "message": "Must be a valid email address"
///     }
///   ],
///   "password": [
///     {
///       "code": "length",
///       "message": "Must be at least 8 characters long"
///     },
///     {
///       "code": "strength",
///       "message": "Must contain a number"
///     }
///   ]
/// }
/// ```
pub(crate) fn format_validator_errors(
    e: validator::ValidationErrors,
) -> serde_json::Value {
    let mut formatted_errors = serde_json::Map::new();

    for (field, field_errors) in e.field_errors() {
        let mut formatted_field_errors = vec![];

        for error in field_errors {
            formatted_field_errors.push(serde_json::json!({
                "code": error.code,
                "message": error.message,
            }));
        }

        formatted_errors.insert(
            field.to_string(),
            serde_json::Value::Array(formatted_field_errors),
        );
    }

    serde_json::Value::Object(formatted_errors)
}