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
129
130
131
132
133
134
135
136
137
use std::borrow::Cow;
use crate::openapi::*;
use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, schemars::JsonSchema)]
pub struct OpenApi {
#[serde(with = "serde_version")]
#[schemars(with = "&'static str")]
pub openapi: Cow<'static, str>,
/// REQUIRED. Provides metadata about the API.
/// The metadata MAY be used by tooling as required.
pub info: Info,
/// The default value for the `$schema` keyword within Schema Objects
/// contained within this OAS document. This MUST be in the form of a URI.
#[serde(rename = "jsonSchemaDialect")]
#[serde(skip_serializing_if = "Option::is_none")]
pub json_schema_dialect: Option<String>,
/// An array of Server Objects, which provide connectivity information to a
/// target server. If the servers property is not provided, or is an empty
/// array, the default value would be a Server Object with a url value of /.
#[serde(default)]
#[serde(skip_serializing_if = "Vec::is_empty")]
pub servers: Vec<Server>,
/// The available paths and operations for the API.
#[serde(skip_serializing_if = "Option::is_none")]
pub paths: Option<Paths>,
/// The incoming webhooks that MAY be received as part of this API and that
/// the API consumer MAY choose to implement. Closely related to the
/// `callbacks` feature, this section describes requests initiated other
/// than by an API call, for example by an out of band registration. The key
/// name is a unique string to refer to each webhook, while the (optionally
/// referenced) Path Item Object describes a request that may be initiated
/// by the API provider and the expected responses.
#[serde(default)]
#[serde(skip_serializing_if = "IndexMap::is_empty")]
pub webhooks: IndexMap<String, ReferenceOr<PathItem>>,
/// An element to hold various schemas for the document.
#[serde(skip_serializing_if = "Option::is_none")]
pub components: Option<Components>,
/// A declaration of which security mechanisms can be used across the API.
///
/// The list of values includes alternative security requirement objects
/// that can be used. Only one of the security requirement objects need to
/// be satisfied to authorize a request. Individual operations can override
/// this definition. Global security settings may be overridden on a
/// per-path basis.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub security: Vec<SecurityRequirement>,
/// A list of tags used by the document with additional metadata.
///
/// The order of the tags can be used to reflect on their order by the
/// parsing tools. Not all tags that are used by the Operation Object
/// must be declared. The tags that are not declared MAY be organized
/// randomly or based on the tool's logic. Each tag name in the list
/// MUST be unique.
#[serde(default)]
#[serde(skip_serializing_if = "Vec::is_empty")]
pub tags: Vec<Tag>,
/// Additional external documentation.
#[serde(rename = "externalDocs")]
#[serde(skip_serializing_if = "Option::is_none")]
pub external_docs: Option<ExternalDocumentation>,
/// Inline extensions to this object.
#[serde(flatten, deserialize_with = "crate::util::deserialize_extensions")]
pub extensions: IndexMap<String, serde_json::Value>,
}
impl OpenApi {
/// Iterates through all [Operation]s in this API.
///
/// The iterated items are tuples of `(&str, &str, &Operation)` containing
/// the path, method, and the operation.
///
/// Path items containing `$ref`s are skipped.
pub fn operations(&self) -> impl Iterator<Item = (&str, &str, &Operation)> {
self.paths.iter().flat_map(|paths| {
paths
.iter()
.filter_map(|(path, item)| item.as_item().map(|i| (path, i)))
.flat_map(|(path, item)| {
item.iter()
.map(move |(method, op)| (path.as_str(), method, op))
})
})
}
}
mod serde_version {
use std::borrow::Cow;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
pub(super) fn serialize<S: Serializer>(
_: &Cow<'static, str>,
ser: S,
) -> Result<S::Ok, S::Error> {
Cow::Borrowed("3.1.0").serialize(ser)
}
pub(super) fn deserialize<'de, D: Deserializer<'de>>(
de: D,
) -> Result<Cow<'static, str>, D::Error> {
<&'de str>::deserialize(de).and_then(|s| match s == "3.1.0" {
true => Ok(Cow::Owned("3.1.0".to_owned())),
false => Err(serde::de::Error::custom("expected 3.1.0")),
})
}
}
#[cfg(test)]
mod tests {
use crate::openapi::OpenApi;
#[test]
fn test_default_openapi_deserialize() {
let mut api = OpenApi::default();
api.openapi = std::borrow::Cow::Borrowed("3.1.0");
let json = serde_json::to_string(&api).unwrap();
let deser_api = serde_json::from_str::<OpenApi>(&json).unwrap();
assert_eq!(api, deser_api);
}
}