by-macros 0.2.0

Biyard Macros
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

# Biyard Macros

## API Model
### Usage
- `crate::Result` must be declared.
- For using `ApiError` as result error type, you should implement `From<String>` into inner error type
- If you want to use fully customized error type, you should implement `From<reqwest::Error>`.

``` rust
#[cfg(feature = "server")]
use by_axum::aide;

use by_macros::api_model;
use serde::{Deserialize, Serialize};

type Result<T> = std::result::Result<T, by_types::ApiError<String>>;

#[derive(Serialize, Deserialize)]
#[api_model(get = "/topics/v1/:id", list = "/topics/v1", iter_type=Vec)]
pub struct Topic {
    #[api_model(summary)]
    pub id: String,
    #[api_model(summary)]
    pub title: String,
    #[api_model(summary, queryable)]
    pub description: String,
    #[api_model(summary, queryable)]
    pub status: i32,
    #[api_model(summary)]
    pub created_at: i64,

    pub updated_at: i64,
    pub tags: Vec<String>,
}

```

### Expanded code

``` rust
pub struct Topic {
    #[api_model(summary)]
    pub id: String,
    #[api_model(summary)]
    pub title: String,
    #[api_model(summary, queryable)]
    pub description: String,
    #[api_model(summary, queryable)]
    pub status: i32,
    #[api_model(summary)]
    pub created_at: i64,

    pub updated_at: i64,
    pub tags: Vec<String>,
}

impl Topic {
    pub fn get_client(endpoint: &str) -> TopicClient {
        TopicClient { endpoint : endpoint.to_string() }
    }
}

pub struct TopicSummary {
    pub id: String,
    pub title: String,
    pub description: String,
    pub status: i32,
    pub created_at: i64,
}

pub struct TopicQuery {
    pub size: usize,
    pub bookmark: Option<String>,
    pub description: Option<String>,
    pub status: Option<i32>,
}

pub struct TopicClient {
    pub endpoint: String,
}

impl TopicClient {
    pub async fn query(&self, params:TopicQuery) -> crate::Result<Vec<TopicSummary>> {
        let endpoint = format!("{}{}", self.endpoint, "/topics/v1");
        let query = format!("{}?{}", endpoint, params);
        rest_api::get(&query).await
    }

    pub async fn get(&self, id: &str) -> crate::Result<Topic> {
        let endpoint = format!("{}{}{}", self.endpoint, "/topics/v1/:id", id);
        rest_api::get(& endpoint).await
    }
}
```