restify-openapi 0.0.1

STILL WIP
Documentation 
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

use indexmap::IndexMap;
use serde::Serialize;
use serde_json::Value;

/// The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
#[derive(Serialize, Clone, Debug, Default)]
#[cfg_attr(any(test, feature = "deserialize"), derive(serde::Deserialize, PartialEq))]
#[serde(rename_all = "camelCase")]
pub struct Info {
  /// The title of the API
  pub title: String,
  /// A short description of the API. [CommonMark](https://spec.commonmark.org/) syntax MAY be used for rich text representation.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub description: Option<String>,
  /// A URL to the Terms of Service for the API. MUST be in the format of a URL.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub terms_of_service: Option<String>,
  /// The contact information for the exposed API.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub contact: Option<Contact>,
  /// The license information for the exposed API.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub license: Option<License>,
  /// The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oasVersion) or the API implementation version).
  pub version: String,
  /// 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>,
}

/// Contact information for the exposed API.
#[derive(Serialize, Clone, Debug, Default)]
#[cfg_attr(any(test, feature = "deserialize"), derive(serde::Deserialize, PartialEq))]
#[serde(rename_all = "camelCase")]
pub struct Contact {
  /// The identifying name of the contact person/organization.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub name: Option<String>,
  /// The URL pointing to the contact information. MUST be in the format of a URL.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub url: Option<String>,
  /// The email address of the contact person/organization. MUST be in the format of an email address.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub email: Option<String>,
  /// 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>,
}

/// License information for the exposed API.
#[derive(Serialize, Clone, Debug, Default)]
#[cfg_attr(any(test, feature = "deserialize"), derive(serde::Deserialize, PartialEq))]
#[serde(rename_all = "camelCase")]
pub struct License {
  /// The license name used for the API.
  pub name: String,
  /// A URL to the license used for the API. MUST be in the format of a URL.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub url: Option<String>,
  /// 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>,
}