apistos-core 0.6.0

Actix-web OpenAPI v3.0 documentation generator
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

use crate::ApiComponent;
use actix_web::web::Header;
use apistos_models::Schema;
use apistos_models::paths::{Parameter, ParameterDefinition, ParameterIn, ParameterStyle, RequestBody};
use apistos_models::reference_or::ReferenceOr;

pub trait ApiHeader {
  fn name() -> String;
  fn description() -> Option<String> {
    None
  }
  fn required() -> bool {
    Default::default()
  }
  fn deprecated() -> bool {
    Default::default()
  }
}

impl<T> ApiComponent for Header<T>
where
  T: ApiComponent + ApiHeader,
{
  fn child_schemas() -> Vec<(String, ReferenceOr<Schema>)> {
    T::child_schemas()
  }

  fn raw_schema() -> Option<ReferenceOr<Schema>> {
    T::raw_schema()
  }

  fn schema() -> Option<(String, ReferenceOr<Schema>)> {
    None
  }

  fn request_body() -> Option<RequestBody> {
    None
  }

  fn parameters() -> Vec<Parameter> {
    vec![Parameter {
      name: T::name(),
      _in: ParameterIn::Header,
      description: T::description(),
      required: Some(<T as ApiHeader>::required()),
      deprecated: Some(<T as ApiHeader>::deprecated()),
      style: Some(ParameterStyle::Simple),
      definition: T::schema()
        .map(|(_, schema)| schema)
        .or_else(Self::raw_schema)
        .map(ParameterDefinition::Schema),
      ..Default::default()
    }]
  }
}

#[cfg(feature = "garde")]
impl<T> ApiComponent for garde_actix_web::web::Header<T>
where
  T: ApiComponent + ApiHeader,
{
  fn child_schemas() -> Vec<(String, ReferenceOr<Schema>)> {
    T::child_schemas()
  }

  fn raw_schema() -> Option<ReferenceOr<Schema>> {
    T::raw_schema()
  }

  fn schema() -> Option<(String, ReferenceOr<Schema>)> {
    None
  }

  fn request_body() -> Option<RequestBody> {
    None
  }

  fn parameters() -> Vec<Parameter> {
    vec![Parameter {
      name: T::name(),
      _in: ParameterIn::Header,
      description: T::description(),
      required: Some(<T as ApiHeader>::required()),
      deprecated: Some(<T as ApiHeader>::deprecated()),
      style: Some(ParameterStyle::Simple),
      definition: T::schema()
        .map(|(_, schema)| schema)
        .or_else(Self::raw_schema)
        .map(ParameterDefinition::Schema),
      ..Default::default()
    }]
  }
}