xui-rs 2.0.1

A modern, typed async Rust SDK for the 3x-ui panel API
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

use std::collections::BTreeSet;

use serde_json::Value;

const SDK_ROUTES: &[(&str, &str, Option<&str>)] = &[
    (
        "get",
        "/panel/api/openapi.json",
        Some("get_panel_api_openapi_json"),
    ),
    (
        "post",
        "/panel/api/backuptotgbot",
        Some("post_panel_api_backuptotgbot"),
    ),
    ("get", "/{subPath}{subid}", Some("get_subPath_subid")),
    ("head", "/{subPath}{subid}", Some("head_subPath_subid")),
    ("get", "/{jsonPath}{subid}", Some("get_jsonPath_subid")),
    ("head", "/{jsonPath}{subid}", Some("head_jsonPath_subid")),
    ("get", "/{clashPath}{subid}", Some("get_clashPath_subid")),
    ("head", "/{clashPath}{subid}", Some("head_clashPath_subid")),
    (
        "get",
        "/{subPath}{subid}/hwid-status",
        Some("get_subPath_subid_hwid_status"),
    ),
    (
        "head",
        "/{subPath}{subid}/hwid-status",
        Some("head_subPath_subid_hwid_status"),
    ),
    ("get", "/mihomo/{subid}", None),
    ("head", "/mihomo/{subid}", None),
    ("get", "/clash-legacy/{subid}", None),
    ("head", "/clash-legacy/{subid}", None),
];

/// Checks API-document, backup, and subscription routes against both upstream contract snapshots.
#[test]
fn sdk_covers_every_remaining_openapi_and_source_http_route() {
    let openapi: Value =
        serde_json::from_str(include_str!("../spec/3x-ui-v3.8.5.openapi.json")).unwrap();
    let documented = openapi["paths"]
        .as_object()
        .unwrap()
        .iter()
        .flat_map(|(path, item)| {
            item.as_object().into_iter().flat_map(move |operations| {
                operations
                    .iter()
                    .filter(move |(_, operation)| {
                        path == "/panel/api/openapi.json"
                            || operation["tags"].as_array().is_some_and(|tags| {
                                tags.iter().any(|tag| {
                                    matches!(tag.as_str(), Some("Backup" | "Subscription Server"))
                                })
                            })
                    })
                    .map(move |(method, operation)| {
                        (
                            method.as_str(),
                            path.as_str(),
                            operation["operationId"].as_str().unwrap(),
                        )
                    })
            })
        })
        .collect::<BTreeSet<_>>();
    let implemented_openapi = SDK_ROUTES
        .iter()
        .filter_map(|(method, path, operation)| {
            operation.map(|operation| (*method, *path, operation))
        })
        .collect::<BTreeSet<_>>();
    assert_eq!(documented.len(), 10);
    assert_eq!(documented, implemented_openapi);

    let snapshot: Value = serde_json::from_str(include_str!(
        "../spec/3x-ui-v3.8.5.remaining-http-routes.json"
    ))
    .unwrap();
    let source = snapshot["routes"]
        .as_array()
        .unwrap()
        .iter()
        .map(|route| {
            (
                route["method"].as_str().unwrap(),
                route["path"].as_str().unwrap(),
            )
        })
        .collect::<BTreeSet<_>>();
    let implemented = SDK_ROUTES
        .iter()
        .map(|(method, path, _)| (*method, *path))
        .collect::<BTreeSet<_>>();
    assert_eq!(source.len(), 14);
    assert_eq!(source, implemented);
}