openapi-contract 0.1.0

Compile-time OpenAPI contract checking for Rust HTTP clients. Validates paths, parameters, and response types against your OpenAPI spec at macro expansion.
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

use std::future::Future;

use crate::error::ApiError;
use crate::sse::SseStream;

/// HTTP method for API requests.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Method {
    GET,
    POST,
    PUT,
    DELETE,
    PATCH,
    HEAD,
    OPTIONS,
}

impl Method {
    pub fn as_reqwest(&self) -> reqwest::Method {
        match self {
            Self::GET => reqwest::Method::GET,
            Self::POST => reqwest::Method::POST,
            Self::PUT => reqwest::Method::PUT,
            Self::DELETE => reqwest::Method::DELETE,
            Self::PATCH => reqwest::Method::PATCH,
            Self::HEAD => reqwest::Method::HEAD,
            Self::OPTIONS => reqwest::Method::OPTIONS,
        }
    }
}

/// Trait for making async API requests.
///
/// Implement this for your HTTP client (e.g. a wrapper around `reqwest::Client`).
pub trait ApiClient: Send + Sync {
    fn request(
        &self,
        method: Method,
        path: &str,
        query: Option<&str>,
        body: Option<String>,
    ) -> impl Future<Output = Result<reqwest::Response, ApiError>> + Send;

    fn request_stream(
        &self,
        method: Method,
        path: &str,
        query: Option<&str>,
    ) -> impl Future<Output = Result<SseStream, ApiError>> + Send;
}

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

    #[test]
    fn method_conversions_and_traits() {
        // as_reqwest covers all variants
        assert_eq!(Method::GET.as_reqwest(), reqwest::Method::GET);
        assert_eq!(Method::POST.as_reqwest(), reqwest::Method::POST);
        assert_eq!(Method::PUT.as_reqwest(), reqwest::Method::PUT);
        assert_eq!(Method::DELETE.as_reqwest(), reqwest::Method::DELETE);
        assert_eq!(Method::PATCH.as_reqwest(), reqwest::Method::PATCH);
        assert_eq!(Method::HEAD.as_reqwest(), reqwest::Method::HEAD);
        assert_eq!(Method::OPTIONS.as_reqwest(), reqwest::Method::OPTIONS);

        // Debug, Eq, Copy
        assert_eq!(format!("{:?}", Method::GET), "GET");
        assert_eq!(Method::GET, Method::GET);
        assert_ne!(Method::GET, Method::POST);
        let m = Method::PUT;
        let m2 = m;
        assert_eq!(m, m2);
    }
}