sova-vld 0.1.4

vld validation integration for Sova
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

//! Sugar: `Doc::new().body::<T>()` for vld `schema!` types (feature `openapi`).
//!
//! Prefer route-level [`.validate_body::<T>()`](crate::ValidateRouteExt) which also
//! fills [`sova_openapi::OpenApiValidate`]. These `Doc` helpers remain for response
//! schemas (`ok` / `created`) and manual docs.

use sova_openapi::Doc;

/// Types that expose `json_schema()` (vld `schema!` with vld's `openapi` feature).
pub trait VldDocSchema {
    fn json_schema() -> serde_json::Value;
}

/// Implement [`VldDocSchema`] for vld `schema!` structs.
///
/// Expands without requiring the consumer crate to depend on `serde_json`
/// (uses the `sova-vld` re-export).
#[macro_export]
macro_rules! doc_schema {
    ($($t:ty),+ $(,)?) => {
        $(
            impl $crate::VldDocSchema for $t {
                fn json_schema() -> $crate::serde_json::Value {
                    <$t>::json_schema()
                }
            }
        )+
    };
}

pub trait DocVldExt {
    /// Prefer `.validate_body::<T>()` on the route for request bodies.
    fn body<T: VldDocSchema>(self) -> Self;
    /// Prefer `.validate_query::<T>()` on the route.
    fn query<T: VldDocSchema>(self) -> Self;
    /// Prefer `.validate_params::<T>()` on the route.
    fn params<T: VldDocSchema>(self) -> Self;
    fn ok<T: VldDocSchema>(self) -> Self;
    fn created<T: VldDocSchema>(self) -> Self;
}

impl DocVldExt for Doc {
    fn body<T: VldDocSchema>(self) -> Self {
        self.body_schema(T::json_schema())
    }
    fn query<T: VldDocSchema>(self) -> Self {
        self.query_schema(T::json_schema())
    }
    fn params<T: VldDocSchema>(self) -> Self {
        self.params_schema(T::json_schema())
    }
    fn ok<T: VldDocSchema>(self) -> Self {
        self.ok_schema(T::json_schema())
    }
    fn created<T: VldDocSchema>(self) -> Self {
        self.created_schema(T::json_schema())
    }
}