apic-cli 0.2.2

A lightweight, Git-friendly CLI tool for designing and collaborating on API contracts 
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

//! Minimal Postman Collection v2.0.0 model.
//!
//! Only the fields `apic convert` actually reads are declared; serde ignores
//! every other key in the export, so this parses any real-world v2.0
//! collection regardless of the Postman features it uses.

use serde::Deserialize;

#[derive(Debug, Deserialize)]
pub struct Spec {
    #[serde(default)]
    pub item: Vec<Items>,
}

/// An entry in an `item` array: either a request (leaf) or a folder (group).
///
/// Disambiguated by required fields — a leaf has `request`, a folder has `item`.
#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum Items {
    Item(Item),
    ItemGroup(ItemGroup),
}

/// A single request and its saved responses. The required `request` field is
/// what distinguishes a leaf from a folder during untagged matching.
#[derive(Debug, Deserialize)]
pub struct Item {
    pub name: Option<String>,
    pub description: Option<DescriptionUnion>,
    pub request: RequestClass,
    pub response: Option<Vec<ResponseClass>>,
}

/// A folder grouping nested items.
#[derive(Debug, Deserialize)]
pub struct ItemGroup {
    pub name: Option<String>,
    pub item: Vec<Items>,
}

#[derive(Debug, Deserialize)]
pub struct RequestClass {
    pub method: Option<String>,
    pub url: Option<Url>,
    pub header: Option<Vec<Header>>,
    pub body: Option<Body>,
}

/// A URL is either the literal string or a broken-down object with a `raw` form.
#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum Url {
    String(String),
    UrlClass(UrlClass),
}

#[derive(Debug, Deserialize)]
pub struct UrlClass {
    pub raw: Option<String>,
}

#[derive(Debug, Deserialize)]
pub struct Header {
    #[serde(default)]
    pub key: String,
    #[serde(default)]
    pub value: String,
    pub disabled: Option<bool>,
}

#[derive(Debug, Deserialize)]
pub struct Body {
    pub raw: Option<String>,
}

#[derive(Debug, Deserialize)]
pub struct ResponseClass {
    pub code: Option<i64>,
    pub status: Option<String>,
    pub body: Option<String>,
}

/// A description is either a raw string or an object holding the text.
#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum DescriptionUnion {
    Description(Description),
    String(String),
}

#[derive(Debug, Deserialize)]
pub struct Description {
    pub content: Option<String>,
}