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

//! [OAS 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) models over [schemars](https://github.com/GREsau/schemars)'s [`Schema`](https://docs.rs/schemars/latest/schemars/schema/enum.Schema.html).
//!
//! These models are not linked to any web framework.

// schemars::Schema does not implement Eq
#![allow(clippy::derive_partial_eq_without_eq)]

use crate::components::Components;
use crate::info::Info;
use crate::paths::{ExternalDocumentation, Paths};
use crate::security::SecurityRequirement;
use crate::server::Server;
use crate::tag::Tag;
use indexmap::IndexMap;
use serde::Serialize;
use serde_json::Value;

pub mod components;
pub mod info;
pub mod paths;
pub mod reference_or;
pub mod security;
pub mod server;
pub mod tag;

pub use schemars::schema::*;

#[derive(Serialize, Clone, Debug)]
#[cfg_attr(any(test, feature = "deserialize"), derive(serde::Deserialize, PartialEq))]
pub enum OpenApiVersion {
  #[serde(rename = "3.0.3")]
  OAS3_0,
}

impl Default for OpenApiVersion {
  fn default() -> Self {
    Self::OAS3_0
  }
}

/// This is the root document object of the [OpenAPI document](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-document).
#[derive(Serialize, Clone, Debug, Default)]
#[cfg_attr(any(test, feature = "deserialize"), derive(serde::Deserialize, PartialEq))]
#[serde(rename_all = "camelCase")]
pub struct OpenApi {
  /// This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#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://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion) string.
  pub openapi: OpenApiVersion,
  /// 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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object) with a [url](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#serverUrl) value of `/`.
  pub servers: Vec<Server>,
  /// The available paths and operations for the API.
  pub paths: Paths,
  /// 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. To make security optional, an empty security requirement (`{}`) can be included in the array.
  #[serde(skip_serializing_if = "Vec::is_empty", default)]
  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://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#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(skip_serializing_if = "Vec::is_empty", default)]
  pub tags: Vec<Tag>,
  /// Additional external documentation.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub external_docs: Option<ExternalDocumentation>,
  /// This object MAY be extended with [Specification Extensions](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specification-extensions).
  #[serde(flatten, skip_serializing_if = "IndexMap::is_empty", skip_deserializing)]
  pub extensions: IndexMap<String, Value>,
}

#[cfg(test)]
mod tests {
  #![allow(clippy::expect_used)]
  use crate::info::Info;
  use crate::paths::{Operation, OperationType, PathItem, Paths, Response, Responses};
  use crate::reference_or::ReferenceOr;
  use crate::server::Server;
  use crate::tag::Tag;
  use crate::{OpenApi, OpenApiVersion};
  use indexmap::IndexMap;
  use std::collections::BTreeMap;

  #[test]
  fn empty_openapi_properly_generated() {
    let oas = OpenApi {
      openapi: OpenApiVersion::OAS3_0,
      info: Info {
        title: "Test".to_string(),
        description: Some("Description".to_string()),
        version: "1.0.0".to_string(),
        ..Default::default()
      },
      paths: Paths::default(),
      ..Default::default()
    };

    let oas_json = serde_json::to_string_pretty(&oas).expect("Error generating json for oas");
    assert_eq!(oas_json, include_str!("../test-assets/empty-openapi.json"));
  }

  #[test]
  fn openapi_properly_generated() {
    let oas = OpenApi {
      openapi: OpenApiVersion::OAS3_0,
      info: Info {
        title: "Test".to_string(),
        description: Some("Description".to_string()),
        version: "1.0.0".to_string(),
        ..Default::default()
      },
      servers: vec![Server {
        url: "https://google.com".to_string(),
        description: Some("A big search server".to_string()),
        ..Default::default()
      }],
      paths: Paths {
        paths: IndexMap::from_iter(vec![(
          "/search".to_string(),
          PathItem {
            operations: IndexMap::from_iter(vec![(
              OperationType::Get,
              Operation {
                tags: vec!["Search".to_string()],
                summary: Some("I don't know what this do".to_string()),
                operation_id: Some("get_search".to_string()),
                responses: Responses {
                  responses: BTreeMap::from_iter(vec![(
                    "200".to_string(),
                    ReferenceOr::Object(Response {
                      description: "A search thingy".to_string(),
                      ..Default::default()
                    }),
                  )]),
                  ..Default::default()
                },
                ..Default::default()
              },
            )]),
            ..Default::default()
          },
        )]),
        ..Default::default()
      },
      tags: vec![Tag {
        name: "Search".to_string(),
        ..Default::default()
      }],
      ..Default::default()
    };

    let oas_json = serde_json::to_string_pretty(&oas).expect("Error generating json for oas");
    assert_eq!(oas_json, include_str!("../test-assets/openapi.json"));
  }
}