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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
//! Structures used in parsing and navigating OpenAPI specifications.
//!
//! High-level structures include [`Spec`], [`Components`] & [`Schema`].
use std::{collections::BTreeMap, iter::Iterator};
use derive_more::derive::Error;
use http::Method;
use log::debug;
use serde::{Deserialize, Serialize};
mod components;
mod contact;
mod encoding;
mod callback;
mod discriminator;
mod error;
mod example;
mod external_doc;
mod flows;
mod header;
mod info;
mod license;
mod link;
mod media_type;
mod media_type_examples;
mod operation;
mod parameter;
mod path_item;
mod r#ref;
mod request_body;
mod response;
mod schema;
mod security_requirement;
mod security_scheme;
mod server;
mod spec_extensions;
mod tag;
pub use self::{
callback::*,
components::*,
contact::*,
discriminator::*,
encoding::*,
error::Error,
example::*,
external_doc::*,
flows::*,
header::*,
info::*,
license::*,
link::*,
media_type::*,
media_type_examples::*,
operation::*,
parameter::*,
path_item::*,
r#ref::*,
request_body::*,
response::*,
schema::{
BooleanSchema, Error as SchemaError, ObjectSchema, Schema, Type as SchemaType,
TypeSet as SchemaTypeSet,
},
security_requirement::*,
security_scheme::*,
server::*,
tag::*,
};
const OPENAPI_SUPPORTED_VERSION_RANGE: &str = "~3.1";
/// A complete OpenAPI specification.
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
pub struct Spec {
/// This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html)
/// of the
/// [OpenAPI Specification version](https://spec.openapis.org/oas/v3.1.1#versions)
/// that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling
/// specifications and clients to interpret the OpenAPI document. This is not related to
/// the API
/// [`info.version`](https://spec.openapis.org/oas/v3.1.1#infoVersion)
/// string.
pub openapi: String,
/// Provides metadata about the API. The metadata MAY be used by tooling as required.
pub info: Info,
/// 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 `/`.
///
/// [Server Object]: https://spec.openapis.org/oas/v3.1.1#server-object
/// [url]: https://spec.openapis.org/oas/v3.1.1#server-url
// FIXME: Provide a default value as specified in documentation instead of `None`.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub servers: Vec<Server>,
/// Holds the relative paths to the individual endpoints and their operations.
///
/// The path is appended to the URL from the [Server Object] in order to construct the full URL.
/// The Paths MAY be empty, due to [ACL constraints].
///
/// [Server Object]: https://spec.openapis.org/oas/v3.1.1#server-object
/// [ACL constraints]: https://spec.openapis.org/oas/v3.1.1#security-filtering
#[serde(skip_serializing_if = "Option::is_none")]
pub paths: Option<BTreeMap<String, PathItem>>,
/// An element to hold various schemas for the specification.
#[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. The list can be incomplete, up to being
/// empty or absent. To make security explicitly optional, an empty security requirement (`{}`)
/// can be included in the array.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub security: Vec<SecurityRequirement>,
/// A list of tags used by the specification 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](https://spec.openapis.org/oas/v3.1.1#operation-object)
/// must be declared. The tags that are not declared MAY be organized randomly or
/// based on the tools' logic. Each tag name in the list MUST be unique.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub tags: Vec<Tag>,
/// 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. An example is available.
///
/// See <>.
#[serde(default)]
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub webhooks: BTreeMap<String, PathItem>,
/// Additional external documentation.
#[serde(skip_serializing_if = "Option::is_none", rename = "externalDocs")]
pub external_docs: Option<ExternalDoc>,
/// Specification extensions.
///
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
///
/// See <https://spec.openapis.org/oas/v3.1.1#specification-extensions>.
#[serde(flatten, with = "spec_extensions")]
pub extensions: BTreeMap<String, serde_json::Value>,
}
impl Spec {
/// Validates spec version field.
pub fn validate_version(&self) -> Result<semver::Version, Error> {
let spec_version = &self.openapi;
let sem_ver = semver::Version::parse(spec_version)?;
let required_version = semver::VersionReq::parse(OPENAPI_SUPPORTED_VERSION_RANGE).unwrap();
if required_version.matches(&sem_ver) {
Ok(sem_ver)
} else {
Err(Error::UnsupportedSpecFileVersion(sem_ver))
}
}
/// Returns a reference to the operation with given `operation_id`, or `None` if not found.
pub fn operation_by_id(&self, operation_id: &str) -> Option<&Operation> {
self.operations()
.find(|(_, _, op)| {
op.operation_id
.as_deref()
.is_some_and(|id| id == operation_id)
})
.map(|(_, _, op)| op)
}
/// Returns a reference to the operation with given `method` and `path`, or `None` if not found.
pub fn operation(&self, method: &http::Method, path: &str) -> Option<&Operation> {
let resource = self.paths.as_ref()?.get(path)?;
match *method {
Method::GET => resource.get.as_ref(),
Method::POST => resource.post.as_ref(),
Method::PUT => resource.put.as_ref(),
Method::PATCH => resource.patch.as_ref(),
Method::DELETE => resource.delete.as_ref(),
Method::HEAD => resource.head.as_ref(),
Method::OPTIONS => resource.options.as_ref(),
Method::TRACE => resource.trace.as_ref(),
_ => None,
}
}
/// Returns an iterator over all the operations defined in this spec.
pub fn operations(&self) -> impl Iterator<Item = (String, Method, &Operation)> {
let paths = &self.paths;
debug!(
"num paths: {}",
paths.as_ref().map_or(0, |paths| paths.len())
);
let ops = paths
.iter()
.flatten()
.flat_map(|(path, item)| {
debug!(
"path: {}, methods: {}",
path,
item.methods().into_iter().count()
);
item.methods()
.into_iter()
.map(move |(method, op)| (path.to_owned(), method, op))
})
.collect::<Vec<_>>();
debug!("num ops: {}", ops.len());
ops.into_iter()
}
/// Returns a reference to the primary (first) server definition.
pub fn primary_server(&self) -> Option<&Server> {
self.servers.first()
}
}