rapina 0.8.0

A fast, type-safe web framework for Rust inspired by FastAPI
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

//! Route metadata for introspection.

use serde::Serialize;

use crate::error::ErrorVariant;

/// Metadata about a registered route.
///
/// Contains information about a route's HTTP method, path pattern,
/// and handler name for introspection and documentation generation.
///
/// # Examples
///
/// ```
/// use rapina::introspection::RouteInfo;
///
/// let info = RouteInfo::new("GET", "/users/:id", "get_user", None, Vec::new());
/// assert_eq!(info.method, "GET");
/// assert_eq!(info.path, "/users/:id");
/// ```
#[derive(Debug, Clone, Serialize, PartialEq)]
pub struct RouteInfo {
    /// The HTTP method (GET, POST, PUT, DELETE, etc.).
    pub method: String,
    /// The path pattern with parameters (e.g., "/users/:id").
    pub path: String,
    /// The name of the handler function.
    pub handler_name: String,
    /// JSON Schema for the success response.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub response_schema: Option<serde_json::Value>,
    /// Error variants for OpenAPI documentation.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub error_responses: Vec<ErrorVariant>,
}

impl RouteInfo {
    /// Creates a new RouteInfo with the given metadata.
    pub fn new(
        method: impl Into<String>,
        path: impl Into<String>,
        handler_name: impl Into<String>,
        response_schema: Option<serde_json::Value>,
        error_responses: Vec<ErrorVariant>,
    ) -> Self {
        Self {
            method: method.into(),
            path: path.into(),
            handler_name: handler_name.into(),
            response_schema,
            error_responses,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_route_info_new() {
        let info = RouteInfo::new("GET", "/users", "list_users", None, Vec::new());
        assert_eq!(info.method, "GET");
        assert_eq!(info.path, "/users");
        assert_eq!(info.handler_name, "list_users");
    }

    #[test]
    fn test_route_info_with_params() {
        let info = RouteInfo::new("GET", "/users/:id", "get_user", None, Vec::new());
        assert_eq!(info.path, "/users/:id");
    }

    #[test]
    fn test_route_info_clone() {
        let info = RouteInfo::new("POST", "/users", "create_user", None, Vec::new());
        let cloned = info.clone();
        assert_eq!(info, cloned);
    }

    #[test]
    fn test_route_info_serialize() {
        let info = RouteInfo::new("GET", "/health", "health_check", None, Vec::new());
        let json = serde_json::to_string(&info).unwrap();
        assert!(json.contains("\"method\":\"GET\""));
        assert!(json.contains("\"path\":\"/health\""));
        assert!(json.contains("\"handler_name\":\"health_check\""));
    }

    #[test]
    fn test_route_info_debug() {
        let info = RouteInfo::new("DELETE", "/users/:id", "delete_user", None, Vec::new());
        let debug = format!("{:?}", info);
        assert!(debug.contains("DELETE"));
        assert!(debug.contains("/users/:id"));
    }

    #[test]
    fn test_route_info_with_error_responses() {
        let errors = vec![ErrorVariant {
            status: 404,
            code: "NOT_FOUND",
            description: "Resource not found",
        }];
        let info = RouteInfo::new("GET", "/users/:id", "get_user", None, errors);
        assert_eq!(info.error_responses.len(), 1);
        assert_eq!(info.error_responses[0].status, 404);
    }
}