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

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

fn fixture(name: &str) -> std::path::PathBuf {
    std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("tests")
        .join("fixtures")
        .join(name)
}

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

#[test]
fn e2e_all_features() {
    let dir = TempDir::new().unwrap();
    let output = dir.path().join("openapi.yaml");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "generate",
            "-i",
            fixture("envelope_test.har").to_str().unwrap(),
            "-t",
            fixture("envelope_templates.yaml").to_str().unwrap(),
            "-o",
            output.to_str().unwrap(),
            "-p",
            PREFIX,
            "--operation-id-strategy",
            "path",
            "--tag-rules",
            fixture("tag-rules-test.yaml").to_str().unwrap(),
            "--envelope-discriminator",
            "success",
        ])
        .assert()
        .success();

    let content = std::fs::read_to_string(&output).unwrap();

    // 1. Every operation should have operationId (--operation-id-strategy path)
    assert!(
        content.contains("operationId:"),
        "expected operationId in output:\n{content}"
    );

    // 2. Tags from rules: Contract and Private
    assert!(
        content.contains("- Contract"),
        "expected 'Contract' tag:\n{content}"
    );
    assert!(
        content.contains("- Private"),
        "expected 'Private' tag:\n{content}"
    );

    // 3. ApiError schema in components (from envelope detection)
    assert!(
        content.contains("ApiError:"),
        "expected ApiError in components:\n{content}"
    );

    // 4. oneOf present (ticker + fair_price both had mixed bodies)
    assert!(
        content.contains("oneOf:"),
        "expected oneOf schema:\n{content}"
    );

    // 5. Output is valid YAML
    let parsed: serde_yaml_ng::Value =
        serde_yaml_ng::from_str(&content).expect("generated spec must be valid YAML");
    assert!(parsed.get("openapi").is_some());
    assert!(parsed.get("paths").is_some());
    assert!(parsed.get("components").is_some());
}

#[test]
fn e2e_no_flags_backward_compat() {
    // Without new flags: no operationId, no components
    let dir = TempDir::new().unwrap();
    let output = dir.path().join("openapi.yaml");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "generate",
            "-i",
            fixture("envelope_test.har").to_str().unwrap(),
            "-t",
            fixture("envelope_templates.yaml").to_str().unwrap(),
            "-o",
            output.to_str().unwrap(),
            "-p",
            PREFIX,
        ])
        .assert()
        .success();

    let content = std::fs::read_to_string(&output).unwrap();
    assert!(
        !content.contains("operationId:"),
        "operationId should NOT appear without --operation-id-strategy:\n{content}"
    );
    assert!(
        !content.contains("components:"),
        "components should NOT appear without --envelope-discriminator:\n{content}"
    );
}