aisil 0.3.2

A lightweight framework to define APIs as types
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

#![allow(clippy::bool_assert_comparison)]
use documented::DocumentedOpt;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use tokio::sync::Mutex;
use ts_rs::TS;

use crate::{ImplsMethod, define_api, mk_handler};

pub type Err = String;

pub type Res<A> = Result<A, Err>;

#[derive(Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct GetA;

#[derive(Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct PostA(pub bool);

/// Some example api
#[derive(DocumentedOpt)]
pub struct SomeAPI;

define_api! { SomeAPI => {
  /// Get A
  "get_a", GetA => bool;
  // not documented on purpose
  "post_a", PostA => Res<()>;
} }

#[derive(DocumentedOpt)]
pub struct SomeAPI2;

define_api! { SomeAPI2 => {
  "get_b", GetA => bool;
} }

#[derive(Clone, Serialize, Deserialize, JsonSchema, TS)]
#[allow(dead_code)]
pub struct GetB;

#[derive(Clone, Default)]
pub struct SomeBackend {
  a: Arc<Mutex<bool>>,
}

impl SomeBackend {
  pub async fn get_a(&self, _: GetA) -> bool {
    *self.a.lock().await
  }
  pub async fn post_a(&self, PostA(new_a): PostA) -> Res<()> {
    let mut a = self.a.lock().await;
    (!*a).then_some(()).ok_or("can't post `a` anymore".to_owned())?;
    *a = new_a;
    Ok(())
  }
  pub async fn get_b(&self, _: GetA) -> bool {
    true
  }
}

mk_handler! {SomeAPI, SomeBackend => {
  get_a : GetA,
  post_a : PostA,
}}

// one backend can implement multiple APIs and some Methods may be in both of
// them. in this case use .call_api_x::<SomeAPI2, _>(req) to specify which API
// to use.
mk_handler! {SomeAPI2, SomeBackend => {
  get_b : GetA,
}}

#[tokio::test]
async fn direct_api_call() {
  use crate::CallApi;
  let backend = SomeBackend::default();
  let () = backend.call_api(PostA(true)).await.unwrap();
  let new_a = backend.call_api_x::<SomeAPI2, _>(GetA).await;
  assert_eq!(new_a, true);
  assert!(backend.call_api(PostA(true)).await.is_err());
}

mod test_macro_1 {
  #![allow(dead_code)]
  struct SomeAPI;
  crate::define_api! { SomeAPI, name = "Some API" => {
    /// Get A
    "get_a", super::GetA => bool;
  } }
}

mod test_macro_2 {
  #![allow(dead_code)]
  struct SomeAPI;
  crate::define_api! { SomeAPI, version = "1.1.0" => {
    /// Get A
    "get_a", super::GetA => bool;
  } }
}

mod test_macro_3 {
  #![allow(dead_code)]
  struct SomeAPI;
  crate::define_api! { SomeAPI, name = "Some API", version = "1.1.0" => {
    /// Get A
    "get_a", super::GetA => bool;
  } }
}

mod test_macro_4 {
  #![allow(dead_code)]
  struct SomeAPI;
  crate::define_api! { SomeAPI, name = "Some API", version = "1.1.0" => {
    /// Get A
    "get_a", super::GetA => bool;
  } }
}

mod test_macro_5 {
  #![allow(dead_code)]
  struct SomeAPI;
  crate::define_api! { SomeAPI, version = "1.1.0", name = "Some API" => {
    /// Get A
    "get_a", super::GetA => bool;
  } }
}