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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
//! Implements [OpenAPI Metadata][info] types.
//!
//! Refer to [`OpenApi`][openapi_trait] trait and [derive documentation][derive]
//! for examples and usage details.
//!
//! [info]: <https://spec.openapis.org/oas/latest.html#info-object>
//! [openapi_trait]: ../../trait.OpenApi.html
//! [derive]: ../../derive.OpenApi.html
use serde::{Deserialize, Serialize};
use super::{builder, extensions::Extensions, set_value};
builder! {
/// # Examples
///
/// Create [`Info`] using [`InfoBuilder`].
/// ```rust
/// # use utoipa::openapi::{Info, InfoBuilder, ContactBuilder};
/// let info = InfoBuilder::new()
/// .title("My api")
/// .version("1.0.0")
/// .contact(Some(ContactBuilder::new()
/// .name(Some("Admin Admin"))
/// .email(Some("amdin@petapi.com"))
/// .build()
/// ))
/// .build();
/// ```
InfoBuilder;
/// OpenAPI [Info][info] object represents metadata of the API.
///
/// You can use [`Info::new`] to construct a new [`Info`] object or alternatively use [`InfoBuilder::new`]
/// to construct a new [`Info`] with chainable configuration methods.
///
/// [info]: <https://spec.openapis.org/oas/latest.html#info-object>
#[non_exhaustive]
#[derive(Serialize, Deserialize, Default, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[serde(rename_all = "camelCase")]
pub struct Info {
/// Title of the API.
pub title: String,
/// Optional description of the API.
///
/// Value supports markdown syntax.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Optional url for terms of service.
#[serde(skip_serializing_if = "Option::is_none")]
pub terms_of_service: Option<String>,
/// Contact information of exposed API.
///
/// See more details at: <https://spec.openapis.org/oas/latest.html#contact-object>.
#[serde(skip_serializing_if = "Option::is_none")]
pub contact: Option<Contact>,
/// License of the API.
///
/// See more details at: <https://spec.openapis.org/oas/latest.html#license-object>.
#[serde(skip_serializing_if = "Option::is_none")]
pub license: Option<License>,
/// Document version typically the API version.
pub version: String,
/// Optional extensions "x-something".
#[serde(skip_serializing_if = "Option::is_none", flatten)]
pub extensions: Option<Extensions>,
}
}
impl Info {
/// Construct a new [`Info`] object.
///
/// This function accepts two arguments. One which is the title of the API and two the
/// version of the api document typically the API version.
///
/// # Examples
///
/// ```rust
/// # use utoipa::openapi::Info;
/// let info = Info::new("Pet api", "1.1.0");
/// ```
pub fn new<S: Into<String>>(title: S, version: S) -> Self {
Self {
title: title.into(),
version: version.into(),
..Default::default()
}
}
}
impl InfoBuilder {
/// Add title of the API.
pub fn title<I: Into<String>>(mut self, title: I) -> Self {
set_value!(self title title.into())
}
/// Add version of the api document typically the API version.
pub fn version<I: Into<String>>(mut self, version: I) -> Self {
set_value!(self version version.into())
}
/// Add description of the API.
pub fn description<S: Into<String>>(mut self, description: Option<S>) -> Self {
set_value!(self description description.map(|description| description.into()))
}
/// Add url for terms of the API.
pub fn terms_of_service<S: Into<String>>(mut self, terms_of_service: Option<S>) -> Self {
set_value!(self terms_of_service terms_of_service.map(|terms_of_service| terms_of_service.into()))
}
/// Add contact information of the API.
pub fn contact(mut self, contact: Option<Contact>) -> Self {
set_value!(self contact contact)
}
/// Add license of the API.
pub fn license(mut self, license: Option<License>) -> Self {
set_value!(self license license)
}
/// Add openapi extensions (x-something) of the API.
pub fn extensions(mut self, extensions: Option<Extensions>) -> Self {
set_value!(self extensions extensions)
}
}
builder! {
/// See the [`InfoBuilder`] for combined usage example.
ContactBuilder;
/// OpenAPI [Contact][contact] information of the API.
///
/// You can use [`Contact::new`] to construct a new [`Contact`] object or alternatively
/// use [`ContactBuilder::new`] to construct a new [`Contact`] with chainable configuration methods.
///
/// [contact]: <https://spec.openapis.org/oas/latest.html#contact-object>
#[non_exhaustive]
#[derive(Serialize, Deserialize, Default, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[serde(rename_all = "camelCase")]
pub struct Contact {
/// Identifying name of the contact person or organization of the API.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Url pointing to contact information of the API.
#[serde(skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// Email of the contact person or the organization of the API.
#[serde(skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Optional extensions "x-something".
#[serde(skip_serializing_if = "Option::is_none", flatten)]
pub extensions: Option<Extensions>,
}
}
impl Contact {
/// Construct a new [`Contact`].
pub fn new() -> Self {
Default::default()
}
}
impl ContactBuilder {
/// Add name contact person or organization of the API.
pub fn name<S: Into<String>>(mut self, name: Option<S>) -> Self {
set_value!(self name name.map(|name| name.into()))
}
/// Add url pointing to the contact information of the API.
pub fn url<S: Into<String>>(mut self, url: Option<S>) -> Self {
set_value!(self url url.map(|url| url.into()))
}
/// Add email of the contact person or organization of the API.
pub fn email<S: Into<String>>(mut self, email: Option<S>) -> Self {
set_value!(self email email.map(|email| email.into()))
}
/// Add openapi extensions (x-something) of the API.
pub fn extensions(mut self, extensions: Option<Extensions>) -> Self {
set_value!(self extensions extensions)
}
}
builder! {
LicenseBuilder;
/// OpenAPI [License][license] information of the API.
///
/// [license]: <https://spec.openapis.org/oas/latest.html#license-object>
#[non_exhaustive]
#[derive(Serialize, Deserialize, Default, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[serde(rename_all = "camelCase")]
pub struct License {
/// Name of the license used e.g MIT or Apache-2.0.
pub name: String,
/// Optional url pointing to the license.
#[serde(skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// An [SPDX-Licenses][spdx_licence] expression for the API. The _`identifier`_ field
/// is mutually exclusive of the _`url`_ field. E.g. Apache-2.0
///
/// [spdx_licence]: <https://spdx.org/licenses/>
#[serde(skip_serializing_if = "Option::is_none")]
pub identifier: Option<String>,
/// Optional extensions "x-something".
#[serde(skip_serializing_if = "Option::is_none", flatten)]
pub extensions: Option<Extensions>,
}
}
impl License {
/// Construct a new [`License`] object.
///
/// Function takes name of the license as an argument e.g MIT.
pub fn new<S: Into<String>>(name: S) -> Self {
Self {
name: name.into(),
..Default::default()
}
}
}
impl LicenseBuilder {
/// Add name of the license used in API.
pub fn name<S: Into<String>>(mut self, name: S) -> Self {
set_value!(self name name.into())
}
/// Add url pointing to the license used in API.
pub fn url<S: Into<String>>(mut self, url: Option<S>) -> Self {
set_value!(self url url.map(|url| url.into()))
}
/// Add openapi extensions (x-something) of the API.
pub fn extensions(mut self, extensions: Option<Extensions>) -> Self {
set_value!(self extensions extensions)
}
/// Set identifier of the licence as [SPDX-Licenses][spdx_licence] expression for the API.
/// The _`identifier`_ field is mutually exclusive of the _`url`_ field. E.g. Apache-2.0
///
/// [spdx_licence]: <https://spdx.org/licenses/>
pub fn identifier<S: Into<String>>(mut self, identifier: Option<S>) -> Self {
set_value!(self identifier identifier.map(|identifier| identifier.into()))
}
}
#[cfg(test)]
mod tests {
use super::Contact;
#[test]
fn contact_new() {
let contact = Contact::new();
assert!(contact.name.is_none());
assert!(contact.url.is_none());
assert!(contact.email.is_none());
}
}