mitm2openapi 0.8.0

Convert mitmproxy flow dumps and HAR files to OpenAPI 3.0 specs — fast Rust rewrite of mitmproxy2swagger
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
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

use assert_cmd::Command;
use tempfile::TempDir;

fn har_fixture(name: &str) -> std::path::PathBuf {
    std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("testdata")
        .join("har")
        .join(name)
}

const PREFIX: &str = "https://api.example.com";

/// Discover with --skip-options: OPTIONS path should NOT appear in templates.
#[test]
fn discover_skip_options_excludes_options_method() {
    let dir = TempDir::new().unwrap();
    let templates = dir.path().join("templates.yaml");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "discover",
            "-i",
            har_fixture("with_options.har").to_str().unwrap(),
            "-o",
            templates.to_str().unwrap(),
            "-p",
            PREFIX,
            "--skip-options",
        ])
        .assert()
        .success();

    let content = std::fs::read_to_string(&templates).unwrap();
    assert!(
        content.contains("/api/users"),
        "GET /api/users should be discovered"
    );
    assert!(
        !content.contains("/api/preflight"),
        "OPTIONS-only path /api/preflight should not appear when --skip-options is set"
    );
}

/// Discover WITHOUT --skip-options: OPTIONS path SHOULD appear in templates.
#[test]
fn discover_without_skip_options_includes_options_method() {
    let dir = TempDir::new().unwrap();
    let templates = dir.path().join("templates.yaml");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "discover",
            "-i",
            har_fixture("with_options.har").to_str().unwrap(),
            "-o",
            templates.to_str().unwrap(),
            "-p",
            PREFIX,
        ])
        .assert()
        .success();

    let content = std::fs::read_to_string(&templates).unwrap();
    assert!(
        content.contains("/api/preflight"),
        "OPTIONS path /api/preflight should appear when --skip-options is NOT set"
    );
}

/// Generate with --skip-options: OPTIONS operation should NOT appear in OpenAPI spec.
#[test]
fn generate_skip_options_excludes_options_operation() {
    let dir = TempDir::new().unwrap();
    let templates = dir.path().join("templates.yaml");
    let output = dir.path().join("openapi.yaml");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "discover",
            "-i",
            har_fixture("with_options.har").to_str().unwrap(),
            "-o",
            templates.to_str().unwrap(),
            "-p",
            PREFIX,
        ])
        .assert()
        .success();

    let tmpl_content = std::fs::read_to_string(&templates).unwrap();
    let activated = tmpl_content.replace("ignore:", "");
    std::fs::write(&templates, activated).unwrap();

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "generate",
            "-i",
            har_fixture("with_options.har").to_str().unwrap(),
            "-t",
            templates.to_str().unwrap(),
            "-o",
            output.to_str().unwrap(),
            "-p",
            PREFIX,
            "--skip-options",
        ])
        .assert()
        .success();

    let spec = std::fs::read_to_string(&output).unwrap();
    assert!(
        !spec.contains("options:"),
        "OPTIONS operation should not appear in spec when --skip-options is set"
    );
    assert!(
        spec.contains("get:"),
        "GET operation should still be present"
    );
}

/// Generate WITHOUT --skip-options: OPTIONS operation SHOULD appear in OpenAPI spec.
#[test]
fn generate_without_skip_options_includes_options_operation() {
    let dir = TempDir::new().unwrap();
    let templates = dir.path().join("templates.yaml");
    let output = dir.path().join("openapi.yaml");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "discover",
            "-i",
            har_fixture("with_options.har").to_str().unwrap(),
            "-o",
            templates.to_str().unwrap(),
            "-p",
            PREFIX,
        ])
        .assert()
        .success();

    let tmpl_content = std::fs::read_to_string(&templates).unwrap();
    let activated = tmpl_content.replace("ignore:", "");
    std::fs::write(&templates, activated).unwrap();

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "generate",
            "-i",
            har_fixture("with_options.har").to_str().unwrap(),
            "-t",
            templates.to_str().unwrap(),
            "-o",
            output.to_str().unwrap(),
            "-p",
            PREFIX,
        ])
        .assert()
        .success();

    let spec = std::fs::read_to_string(&output).unwrap();
    assert!(
        spec.contains("options:"),
        "OPTIONS operation should appear in spec when --skip-options is NOT set"
    );
}