axum-api-kit 1.0.0

Shared response types for Axum JSON APIs: ApiError, ListResponse, and HealthResponse
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

use axum::{
    response::{IntoResponse, Response},
    Json,
};
use serde::Serialize;

/// A cursor-based paginated collection response.
///
/// Unlike [`ListResponse`](crate::ListResponse) which uses offset/limit pagination,
/// `CursorResponse` uses opaque cursor tokens for keyset-based pagination.
/// This is ideal for large or streaming datasets where total count is expensive to compute.
///
/// Serializes as:
/// ```json
/// { "data": [...], "next_cursor": "abc123", "has_more": true }
/// { "data": [...], "next_cursor": null, "has_more": false }
/// ```
///
/// # Example
///
/// ```rust
/// use axum::response::IntoResponse;
/// use axum_api_kit::CursorResponse;
/// use serde::Serialize;
///
/// #[derive(Serialize)]
/// struct Item { id: String }
///
/// async fn list_items(cursor: Option<String>) -> impl IntoResponse {
///     CursorResponse {
///         data: vec![Item { id: "1".into() }],
///         next_cursor: Some("cursor_for_page_2".into()),
///         has_more: true,
///     }
/// }
/// ```
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct CursorResponse<T: Serialize> {
    /// The items in this page.
    pub data: Vec<T>,
    /// Opaque cursor token for fetching the next page.
    /// `None` indicates this is the last page.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next_cursor: Option<String>,
    /// Whether more items exist after this page.
    pub has_more: bool,
}

impl<T: Serialize> IntoResponse for CursorResponse<T> {
    fn into_response(self) -> Response {
        Json(self).into_response()
    }
}

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

    #[derive(Serialize)]
    struct Item {
        id: String,
    }

    #[test]
    fn serializes_with_next_cursor() {
        let resp = CursorResponse {
            data: vec![Item { id: "1".into() }],
            next_cursor: Some("cursor_abc".into()),
            has_more: true,
        };
        let v = serde_json::to_value(&resp).unwrap();
        assert_eq!(v["data"][0]["id"], "1");
        assert_eq!(v["next_cursor"], "cursor_abc");
        assert_eq!(v["has_more"], true);
    }

    #[test]
    fn serializes_without_next_cursor_when_none() {
        let resp: CursorResponse<Item> = CursorResponse {
            data: vec![],
            next_cursor: None,
            has_more: false,
        };
        let v = serde_json::to_value(&resp).unwrap();
        assert!(v.get("next_cursor").is_none());
        assert_eq!(v["has_more"], false);
    }

    #[test]
    fn has_more_false_at_end() {
        let resp = CursorResponse {
            data: vec![Item { id: "final".into() }],
            next_cursor: None,
            has_more: false,
        };
        let v = serde_json::to_value(&resp).unwrap();
        assert_eq!(v["has_more"], false);
        assert!(v.get("next_cursor").is_none());
    }

    #[test]
    fn has_more_true_with_cursor() {
        let resp = CursorResponse {
            data: vec![Item { id: "x".into() }],
            next_cursor: Some("token".into()),
            has_more: true,
        };
        let v = serde_json::to_value(&resp).unwrap();
        assert_eq!(v["has_more"], true);
        assert_eq!(v["next_cursor"], "token");
    }

    #[test]
    fn empty_data_with_no_cursor() {
        let resp: CursorResponse<Item> = CursorResponse {
            data: vec![],
            next_cursor: None,
            has_more: false,
        };
        let v = serde_json::to_value(&resp).unwrap();
        assert_eq!(v["data"], json!([]));
        assert_eq!(v["has_more"], false);
    }

    #[test]
    fn multiple_items() {
        let resp = CursorResponse {
            data: vec![
                Item { id: "1".into() },
                Item { id: "2".into() },
                Item { id: "3".into() },
            ],
            next_cursor: Some("next".into()),
            has_more: true,
        };
        let v = serde_json::to_value(&resp).unwrap();
        assert_eq!(v["data"].as_array().unwrap().len(), 3);
        assert_eq!(v["data"][1]["id"], "2");
    }
}