api-response 0.16.3

A consistent structure for API responses, including success and error handling.
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

use salvo::{
    Scribe, async_trait,
    oapi::{Components, Content, EndpointOutRegister, Operation, RefOr, Response, ToResponse, ToSchema},
    writing::Json,
};
use serde::Serialize;

use crate::ApiResponse;
#[cfg(feature = "lite")]
#[allow(dead_code)]
#[derive(ToSchema)]
struct ApiResponseSchema<Data, Meta> {
    code: u32,
    data: Data,
    meta: Option<Meta>,
    error: crate::lite::__ApiError,
}

#[cfg(not(feature = "lite"))]
#[allow(dead_code)]
#[derive(ToSchema)]
enum ApiStatus {
    Success,
    Error,
}
#[cfg(not(feature = "lite"))]
#[allow(dead_code)]
#[derive(ToSchema)]
struct ApiResponseSchema<Data, Meta> {
    status: ApiStatus,
    data: Data,
    meta: Option<Meta>,
    error: crate::ApiError,
}

impl<Data, Meta> ToSchema for ApiResponse<Data, Meta>
where
    Data: ToSchema + 'static,
    Meta: ToSchema + 'static,
{
    fn to_schema(components: &mut Components) -> RefOr<salvo::oapi::schema::Schema> {
        ApiResponseSchema::<Data, Meta>::to_schema(components)
    }
}

impl<Data, Meta> ToResponse for ApiResponse<Data, Meta>
where
    Data: ToSchema + 'static,
    Meta: ToSchema + 'static,
{
    fn to_response(components: &mut Components) -> RefOr<Response> {
        Response::new("Response with json format data")
            .add_content("application/json", Content::new(Self::to_schema(components)))
            .into()
    }
}

impl<Data, Meta> EndpointOutRegister for ApiResponse<Data, Meta>
where
    Data: ToSchema + 'static,
    Meta: ToSchema + 'static,
{
    #[inline]
    fn register(components: &mut Components, operation: &mut Operation) {
        operation.responses.insert("200", Self::to_response(components));
    }
}

#[async_trait]
impl<Data, Meta> Scribe for ApiResponse<Data, Meta>
where
    Data: Serialize + Send,
    Meta: Serialize + Send,
{
    fn render(self, res: &mut salvo::prelude::Response) {
        Json(self).render(res)
    }
}

#[cfg(test)]
mod tests {
    use salvo::prelude::*;
    use serde_json::{Value, json};

    use crate::*;
    #[endpoint]
    fn get_user() -> ApiResponse<Value, DefaultMeta> {
        let user = json!({
            "id": 123,
            "name": "Andeya Lee",
            "email": "andeya.lee@example.com"
        });
        user.api_response_with_meta(DefaultMeta::new().with_request_id("abc-123"))
    }
}