#验证 #JSON模式 #API #HTTP API #遗传 #HTTP

app beacon-verifier

验证信标实现的合规性工具

19 个版本

0.3.3 2022年12月21日
0.3.2 2021年11月29日
0.2.8 2021年10月29日
0.2.2 2021年9月30日
0.1.3 2021年7月22日

#297 in 测试

Download history 120/week @ 2024-07-02 57/week @ 2024-07-30

57 每月下载量

Apache-2.0

275KB
1K SLoC

信标验证器

beacon-verifier.001.png

安装

要求:Rust 最低 Rust 版本1.56

cargo install beacon-verifier

用法

你可以指定一个或多个 URL

beacon-verifier https://beacon-url.com/

默认情况下,使用的是 信标 v2 模型。但你也可以使用 --model 选项提供自己的模型。模型应遵循 信标框架

beacon-verifier --model https://beacon-model.com/ https://beacon-url.com/

或者,你可以指定模型的本地路径

beacon-verifier --model file://$PWD/tests/BEACON-V2-Model https://beacon-url.com/

输出

输出是一个写入标准输出的 JSON 文件。你可以将其重定向到文件中保存。

beacon-verifier https://beacon-url.com/ > /path/to/output

输出示例

[
    {
        "name": "Beacon Name",
        "url": "https://...",
        "entities": {
            "individuals": {
                "name": "Individuals",
                "url": "https://.../individuals",
                "valid": true,
                "error": null,
            },
            "variants": {
                "name": "Variants",
                "url": "https://.../variants",
                "valid": false,
                "error": "Bad schema"
            },
            "biosamples": {
                "name": "Biosamples",
                "url": "https://.../biosamples",
                "valid": null,
                "error": "Unresponsive endpoint"
            }
        }
    }
]

输出格式

输出是一个具有以下格式的 Vec<Beacon>

struct Beacon {
    name: String,
    url: String,
    entities: Vec<Entity>
}

struct Entity {
    name: String,
    url: String,
    valid: Option<bool>,
    error: Option<VerifierError>
}

依赖项

~22–38MB
~696K SLoC