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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
//! Rust implementation of Openapi Spec V3.
use serde::{de::Error, de::Visitor, Deserialize, Deserializer, Serialize, Serializer};
use std::fmt::Formatter;
pub use self::{
content::{Content, ContentBuilder},
external_docs::ExternalDocs,
header::{Header, HeaderBuilder},
info::{Contact, ContactBuilder, Info, InfoBuilder, License, LicenseBuilder},
path::{PathItem, PathItemType, Paths, PathsBuilder},
response::{Response, ResponseBuilder, Responses, ResponsesBuilder},
schema::{
AllOf, AllOfBuilder, Array, ArrayBuilder, Components, ComponentsBuilder, Discriminator,
KnownFormat, Object, ObjectBuilder, OneOf, OneOfBuilder, Ref, Schema, SchemaFormat,
SchemaType, ToArray,
},
security::SecurityRequirement,
server::{Server, ServerBuilder, ServerVariable, ServerVariableBuilder},
tag::Tag,
};
pub mod content;
pub mod encoding;
pub mod example;
pub mod external_docs;
pub mod header;
pub mod info;
pub mod path;
pub mod request_body;
pub mod response;
pub mod schema;
pub mod security;
pub mod server;
pub mod tag;
pub mod xml;
builder! {
/// # Examples
///
/// Create [`OpenApi`] using [`OpenApiBuilder`].
/// ```rust
/// # use utoipa::openapi::{Info, Paths, Components, OpenApiBuilder};
/// let openapi = OpenApiBuilder::new()
/// .info(Info::new("My api", "1.0.0"))
/// .paths(Paths::new())
/// .components(Some(
/// Components::new()
/// ))
/// .build();
/// ```
OpenApiBuilder;
/// Root object of the OpenAPI document.
///
/// You can use [`OpenApi::new`] function to construct a new [`OpenApi`] instance and then
/// use the fields with mutable access to modify them. This is quite tedious if you are not simply
/// just changing one thing thus you can also use the [`OpenApiBuilder::new`] to use builder to
/// construct a new [`OpenApi`] object.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#openapi-object>.
#[non_exhaustive]
#[derive(Serialize, Deserialize, Default, Clone, PartialEq)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[serde(rename_all = "camelCase")]
pub struct OpenApi {
/// OpenAPI document version.
pub openapi: OpenApiVersion,
/// Provides metadata about the API.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#info-object>.
pub info: Info,
/// Optional list of servers that provides the connectivity information to target servers.
///
/// This is implicitly one server with `url` set to `/`.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#server-object>.
#[serde(skip_serializing_if = "Option::is_none")]
pub servers: Option<Vec<Server>>,
/// Available paths and operations for the API.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#paths-object>.
#[serde(flatten)]
pub paths: Paths,
/// Holds various reusable schemas for the OpenAPI document.
///
/// Few of these elements are security schemas and object schemas.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#components-object>.
#[serde(skip_serializing_if = "Option::is_none")]
pub components: Option<Components>,
/// Declaration of global security mechanisms that can be used across the API. The individual operations
/// can override the declarations. You can use `SecurityRequirement::default()` if you wish to make security
/// optional by adding it to the list of securities.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#security-requirement-object>.
#[serde(skip_serializing_if = "Option::is_none")]
pub security: Option<Vec<SecurityRequirement>>,
/// Optional list of tags can be used to add additional documentation to matching tags of operations.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#tag-object>.
#[serde(skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// Optional global additional documentation reference.
///
/// See more details at <https://spec.openapis.org/oas/latest.html#external-documentation-object>.
#[serde(skip_serializing_if = "Option::is_none")]
pub external_docs: Option<ExternalDocs>,
}
}
impl OpenApi {
/// Construct a new [`OpenApi`] object.
///
/// Function accepts two arguments one which is [`Info`] metadata of the API; two which is [`Paths`]
/// containing operations for the API.
///
/// # Examples
///
/// ```rust
/// # use utoipa::openapi::{Info, Paths, OpenApi};
/// #
/// let openapi = OpenApi::new(Info::new("pet api", "0.1.0"), Paths::new());
/// ```
pub fn new<P: Into<Paths>>(info: Info, paths: P) -> Self {
Self {
info,
paths: paths.into(),
..Default::default()
}
}
/// Converts this [`OpenApi`] to JSON String. This method essentially calls [`serde_json::to_string`] method.
pub fn to_json(&self) -> Result<String, serde_json::Error> {
serde_json::to_string(self)
}
/// Converts this [`OpenApi`] to pretty JSON String. This method essentially calls [`serde_json::to_string_pretty`] method.
pub fn to_pretty_json(&self) -> Result<String, serde_json::Error> {
serde_json::to_string_pretty(self)
}
/// Converts this [`OpenApi`] to YAML String. This method essentially calls [`serde_yaml::to_string`] method.
#[cfg(feature = "yaml")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "yaml")))]
pub fn to_yaml(&self) -> Result<String, serde_yaml::Error> {
serde_yaml::to_string(self)
}
/// Merge `other` [`OpenApi`] consuming it and resuming it's content.
///
/// Merge function will take all `self` nonexistent _`servers`, `paths`, `schemas`, `responses`,
/// `security_schemes`, `security_requirements` and `tags`_ from _`other`_ [`OpenApi`].
///
/// This function performs a shallow comparison for `paths`, `schemas`, `responses` and
/// `security schemes` which means that only _`name`_ and _`path`_ is used for comparison. When
/// match occurs the whole item will be ignored from merged results. Only items not
/// found will be appended to `self`.
///
/// For _`servers`_, _`tags`_ and _`security_requirements`_ the whole item will be used for
/// comparison. Items not found from `self` will be appended to `self`.
///
/// **Note!** `info`, `openapi` and `external_docs` will not be merged.
pub fn merge(&mut self, mut other: OpenApi) {
if let Some(other_servers) = &mut other.servers {
let servers = self.servers.get_or_insert(Vec::new());
other_servers.retain(|server| !servers.contains(server));
servers.append(other_servers);
}
if !other.paths.paths.is_empty() {
other
.paths
.paths
.retain(|path, _| self.paths.get_path_item(path).is_none());
self.paths.paths.extend(&mut other.paths.paths.into_iter());
};
if let Some(other_components) = &mut other.components {
let components = self.components.get_or_insert(Components::default());
other_components
.schemas
.retain(|name, _| !components.schemas.contains_key(name));
components.schemas.append(&mut other_components.schemas);
other_components
.responses
.retain(|name, _| !components.responses.contains_key(name));
components.responses.append(&mut other_components.responses);
other_components
.security_schemes
.retain(|name, _| !components.security_schemes.contains_key(name));
components
.security_schemes
.append(&mut other_components.security_schemes);
}
if let Some(other_security) = &mut other.security {
let security = self.security.get_or_insert(Vec::new());
other_security.retain(|requirement| !security.contains(requirement));
security.append(other_security);
}
if let Some(other_tags) = &mut other.tags {
let tags = self.tags.get_or_insert(Vec::new());
other_tags.retain(|tag| !tags.contains(tag));
tags.append(other_tags);
}
}
}
impl OpenApiBuilder {
/// Add [`Info`] metadata of the API.
pub fn info<I: Into<Info>>(mut self, info: I) -> Self {
set_value!(self info info.into())
}
/// Add iterator of [`Server`]s to configure target servers.
pub fn servers<I: IntoIterator<Item = Server>>(mut self, servers: Option<I>) -> Self {
set_value!(self servers servers.map(|servers| servers.into_iter().collect()))
}
/// Add [`Paths`] to configure operations and endpoints of the API.
pub fn paths<P: Into<Paths>>(mut self, paths: P) -> Self {
set_value!(self paths paths.into())
}
/// Add [`Components`] to configure reusable schemas.
pub fn components(mut self, components: Option<Components>) -> Self {
set_value!(self components components)
}
/// Add iterator of [`SecurityRequirement`]s that are globally available for all operations.
pub fn security<I: IntoIterator<Item = SecurityRequirement>>(
mut self,
security: Option<I>,
) -> Self {
set_value!(self security security.map(|security| security.into_iter().collect()))
}
/// Add iterator of [`Tag`]s to add additional documentation for **operations** tags.
pub fn tags<I: IntoIterator<Item = Tag>>(mut self, tags: Option<I>) -> Self {
set_value!(self tags tags.map(|tags| tags.into_iter().collect()))
}
/// Add [`ExternalDocs`] for referring additional documentation.
pub fn external_docs(mut self, external_docs: Option<ExternalDocs>) -> Self {
set_value!(self external_docs external_docs)
}
}
/// Represents available [OpenAPI versions][version].
///
/// [version]: <https://spec.openapis.org/oas/latest.html#versions>
#[derive(Serialize, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "debug", derive(Debug))]
pub enum OpenApiVersion {
/// Will serialize to `3.0.3` the latest from 3.0 serde.
#[serde(rename = "3.0.3")]
Version3,
}
impl Default for OpenApiVersion {
fn default() -> Self {
Self::Version3
}
}
impl<'de> Deserialize<'de> for OpenApiVersion {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
struct VersionVisitor;
impl<'v> Visitor<'v> for VersionVisitor {
type Value = OpenApiVersion;
fn expecting(&self, formatter: &mut Formatter) -> std::fmt::Result {
formatter.write_str("a version string in 3, 3.0, or 3.0.x format")
}
fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: Error,
{
self.visit_string(v.to_string())
}
fn visit_string<E>(self, v: String) -> Result<Self::Value, E>
where
E: Error,
{
let parts = v.split('.').collect::<Vec<_>>();
if parts.len() > 3 || parts.is_empty() {
return Err(E::custom(format!(
"Invalid format of OpenAPI version: {}",
v,
)));
}
Ok(match (parts[0], parts.get(1).copied().unwrap_or("0")) {
("3", "0") => OpenApiVersion::Version3,
_ => return Err(E::custom(format!("Unsupported version: {}", &v))),
})
}
}
deserializer.deserialize_string(VersionVisitor)
}
}
/// Value used to indicate whether reusable schema, parameter or operation is deprecated.
///
/// The value will serialize to boolean.
#[derive(PartialEq, Eq, Clone)]
#[cfg_attr(feature = "debug", derive(Debug))]
pub enum Deprecated {
True,
False,
}
impl Serialize for Deprecated {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_bool(matches!(self, Self::True))
}
}
impl<'de> Deserialize<'de> for Deprecated {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
struct BoolVisitor;
impl<'de> Visitor<'de> for BoolVisitor {
type Value = Deprecated;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("a bool true or false")
}
fn visit_bool<E>(self, v: bool) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
match v {
true => Ok(Deprecated::True),
false => Ok(Deprecated::False),
}
}
}
deserializer.deserialize_bool(BoolVisitor)
}
}
impl Default for Deprecated {
fn default() -> Self {
Deprecated::False
}
}
/// Value used to indicate whether parameter or property is required.
///
/// The value will serialize to boolean.
#[derive(PartialEq, Eq, Clone)]
#[cfg_attr(feature = "debug", derive(Debug))]
pub enum Required {
True,
False,
}
impl Serialize for Required {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_bool(matches!(self, Self::True))
}
}
impl<'de> Deserialize<'de> for Required {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
struct BoolVisitor;
impl<'de> Visitor<'de> for BoolVisitor {
type Value = Required;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("a bool true or false")
}
fn visit_bool<E>(self, v: bool) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
match v {
true => Ok(Required::True),
false => Ok(Required::False),
}
}
}
deserializer.deserialize_bool(BoolVisitor)
}
}
impl Default for Required {
fn default() -> Self {
Required::False
}
}
/// A [`Ref`] or some other type `T`.
///
/// Typically used in combination with [`Components`] and is an union type between [`Ref`] and any
/// other given type such as [`Schema`] or [`Response`].
#[derive(Serialize, Deserialize, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[serde(untagged)]
pub enum RefOr<T> {
Ref(Ref),
T(T),
}
macro_rules! build_fn {
( $vis:vis $name:ident $( $field:ident ),+ ) => {
#[doc = concat!("Constructs a new [`", stringify!($name),"`] taking all fields values from this object.")]
$vis fn build(self) -> $name {
$name {
$(
$field: self.$field,
)*
}
}
};
}
pub(crate) use build_fn;
macro_rules! set_value {
( $self:ident $field:ident $value:expr ) => {{
$self.$field = $value;
$self
}};
}
pub(crate) use set_value;
macro_rules! new {
( $vis:vis $name:ident ) => {
#[doc = concat!("Constructs a new [`", stringify!($name),"`].")]
$vis fn new() -> $name {
$name {
..Default::default()
}
}
};
}
pub(crate) use new;
macro_rules! from {
( $name:ident $to:ident $( $field:ident ),+ ) => {
impl From<$name> for $to {
fn from(value: $name) -> Self {
Self {
$( $field: value.$field, )*
}
}
}
impl From<$to> for $name {
fn from(value: $to) -> Self {
value.build()
}
}
};
}
pub(crate) use from;
macro_rules! builder {
( $( #[$builder_meta:meta] )* $builder_name:ident; $(#[$meta:meta])* $vis:vis $key:ident $name:ident $( $tt:tt )* ) => {
builder!( @type_impl $( #[$meta] )* $vis $key $name $( $tt )* );
builder!( @builder_impl $( #[$builder_meta] )* $builder_name $( #[$meta] )* $vis $key $name $( $tt )* );
};
( @type_impl $( #[$meta:meta] )* $vis:vis $key:ident $name:ident
{ $( $( #[$field_meta:meta] )* $field_vis:vis $field:ident: $field_ty:ty, )* }
) => {
$( #[$meta] )*
$vis $key $name {
$( $( #[$field_meta] )* $field_vis $field: $field_ty, )*
}
};
( @builder_impl $( #[$builder_meta:meta] )* $builder_name:ident $( #[$meta:meta] )* $vis:vis $key:ident $name:ident
{ $( $( #[$field_meta:meta] )* $field_vis:vis $field:ident: $field_ty:ty, )* }
) => {
#[doc = concat!("Builder for [`", stringify!($name),
"`] with chainable configuration methods to create a new [`", stringify!($name) , "`].")]
$( #[$builder_meta] )*
#[cfg_attr(feature = "debug", derive(Debug))]
$vis $key $builder_name {
$( $field: $field_ty, )*
}
impl Default for $builder_name {
fn default() -> Self {
let meta_default: $name = $name::default();
Self {
$( $field: meta_default.$field, )*
}
}
}
impl $builder_name {
crate::openapi::new!($vis $builder_name);
crate::openapi::build_fn!($vis $name $( $field ),* );
}
crate::openapi::from!($name $builder_name $( $field ),* );
};
}
pub(crate) use builder;
#[cfg(test)]
mod tests {
use serde_json::json;
use crate::openapi::{
info::InfoBuilder,
path::{OperationBuilder, PathsBuilder},
};
use super::{response::Response, *};
#[test]
fn serialize_deserialize_openapi_version_success() -> Result<(), serde_json::Error> {
assert_eq!(serde_json::to_value(&OpenApiVersion::Version3)?, "3.0.3");
Ok(())
}
#[test]
fn serialize_openapi_json_minimal_success() -> Result<(), serde_json::Error> {
let raw_json = include_str!("openapi/testdata/expected_openapi_minimal.json");
let openapi = OpenApi::new(
InfoBuilder::new()
.title("My api")
.version("1.0.0")
.description(Some("My api description"))
.license(Some(
LicenseBuilder::new()
.name("MIT")
.url(Some("http://mit.licence"))
.build(),
))
.build(),
Paths::new(),
);
let serialized = serde_json::to_string_pretty(&openapi)?;
assert_eq!(
serialized, raw_json,
"expected serialized json to match raw: \nserialized: \n{serialized} \nraw: \n{raw_json}"
);
Ok(())
}
#[test]
fn serialize_openapi_json_with_paths_success() -> Result<(), serde_json::Error> {
let openapi = OpenApi::new(
Info::new("My big api", "1.1.0"),
PathsBuilder::new()
.path(
"/api/v1/users",
PathItem::new(
PathItemType::Get,
OperationBuilder::new().response("200", Response::new("Get users list")),
),
)
.path(
"/api/v1/users",
PathItem::new(
PathItemType::Post,
OperationBuilder::new().response("200", Response::new("Post new user")),
),
)
.path(
"/api/v1/users/{id}",
PathItem::new(
PathItemType::Get,
OperationBuilder::new().response("200", Response::new("Get user by id")),
),
),
);
let serialized = serde_json::to_string_pretty(&openapi)?;
let expected = include_str!("./openapi/testdata/expected_openapi_with_paths.json");
assert_eq!(
serialized, expected,
"expected serialized json to match raw: \nserialized: \n{serialized} \nraw: \n{expected}"
);
Ok(())
}
#[test]
fn merge_2_openapi_documents() {
let mut api_1 = OpenApi::new(
Info::new("Api", "v1"),
PathsBuilder::new()
.path(
"/api/v1/user",
PathItem::new(
PathItemType::Get,
OperationBuilder::new().response("200", Response::new("Get user success")),
),
)
.build(),
);
let api_2 = OpenApiBuilder::new()
.info(Info::new("Api", "v2"))
.paths(
PathsBuilder::new()
.path(
"/api/v1/user",
PathItem::new(
PathItemType::Get,
OperationBuilder::new()
.response("200", Response::new("This will not get added")),
),
)
.path(
"/ap/v2/user",
PathItem::new(
PathItemType::Get,
OperationBuilder::new()
.response("200", Response::new("Get user success 2")),
),
)
.path(
"/api/v2/user",
PathItem::new(
PathItemType::Post,
OperationBuilder::new()
.response("200", Response::new("Get user success")),
),
)
.build(),
)
.components(Some(
ComponentsBuilder::new()
.schema(
"User2",
ObjectBuilder::new()
.schema_type(SchemaType::Object)
.property(
"name",
ObjectBuilder::new().schema_type(SchemaType::String).build(),
),
)
.build(),
))
.build();
api_1.merge(api_2);
let value = serde_json::to_value(&api_1).unwrap();
assert_eq!(
value,
json!(
{
"openapi": "3.0.3",
"info": {
"title": "Api",
"version": "v1"
},
"paths": {
"/ap/v2/user": {
"get": {
"responses": {
"200": {
"description": "Get user success 2"
}
}
}
},
"/api/v1/user": {
"get": {
"responses": {
"200": {
"description": "Get user success"
}
}
}
},
"/api/v2/user": {
"post": {
"responses": {
"200": {
"description": "Get user success"
}
}
}
}
},
"components": {
"schemas": {
"User2": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
}
)
)
}
#[test]
fn deserialize_other_versions() {
[r#""3.0.3""#, r#""3.0.0""#, r#""3.0""#, r#""3""#]
.iter()
.for_each(|v| {
assert!(matches!(
serde_json::from_str::<OpenApiVersion>(v).unwrap(),
OpenApiVersion::Version3,
));
});
}
}