TFL API 包装器

A rust crate 用于使用 伦敦交通（TFL）API。

注意：目前仅支持线路API。其他API正在开发中

安装

使用 cargo，将以下内容添加到您的项目 Cargo.toml

[dependencies]
tfl-api-wrapper = "0.1.3"

用法

从 TFL API 站点获取密钥

1. 如果您还没有账户，请注册 TFL API 站点。
2. 访问 产品 链接，为 500 请求每分钟 创建新的订阅（允许每分钟500次请求）。
3. 接下来，访问您的 个人资料，滚动到您的订阅的 主密钥 部分，点击 显示 并复制值。您可以使用 主密钥 或 辅助密钥 中的任何一个。

使用 crate

设置 APP_KEY 环境变量。

使用以下方式实例化 Client

use tfl_api_wrapper::{Client, RequestBuilder};
let client = Client::new(std::env::var("APP_KEY").unwrap());

在这里 APP_KEY 可以是 主密钥 或 辅助密钥。

示例

获取 API 版本

async fn it_is_version_1() {
    use tfl_api_wrapper::{Client, RequestBuilder};
    let client = Client::new(std::env::var("APP_KEY").unwrap());
    let ver = client.api_version().fetch().await.unwrap();
}

列出有效模式

async fn list_valid_modes() {
    use tfl_api_wrapper::{Client, RequestBuilder};
    use std::env;

    let client = Client::new(env::var("APP_KEY").unwrap().into());
    let valid_modes = client.list_modes().fetch().await.unwrap();
}

列出严重类型

async fn list_severity_types() {
    use tfl_api_wrapper::{Client, RequestBuilder};
    use std::env;

    let client = Client::new(env::var("APP_KEY").unwrap().into());
    let severity_types = client.list_severity_types().fetch().await.unwrap();
}

按模式列出路线

async fn list_routes_by_mode() {
    use tfl_api_wrapper::{Client, RequestBuilder, linemodels, models};
    use std::env;

    let client = Client::new(env::var("APP_KEY").unwrap().into());
    let modes: Vec<models::Mode> = vec![models::Mode::Bus, models::Mode::Tube];
    let routes = client
        .list_lines_routes_by_modes()
        .mode(modes)
        .fetch()
        .await
        .unwrap();
}

按线路获取到达预测

async fn get_arrivals_by_lines() {
    use tfl_api_wrapper::{Client, RequestBuilder, linemodels};
    use std::env;

    let client = Client::new(env::var("APP_KEY").unwrap().into());
    let lines: Vec<linemodels::LineID> = vec![linemodels::LineID::Bakerloo, linemodels::LineID::Jubilee];
    let arrivals = client
        .arrival_predictions_by_lines()
        .line(lines)
        .fetch()
        .await
        .unwrap();
}

按模式获取中断信息

async fn get_disruptions_by_lines() {
    use tfl_api_wrapper::{Client, RequestBuilder, linemodels, models};
    use std::env;

    let client = Client::new(env::var("APP_KEY").unwrap().into());
    let modes: Vec<models::Mode> = vec![models::Mode::Bus, models::Mode::Tube];
    let disruptions = client
        .disruptions_by_mode()
        .mode(modes)
        .fetch()
        .await
        .unwrap();
}

测试

您可以通过运行以下命令来运行测试

APP_KEY=hjdhajsdas cargo test

开发者

由于此库维护一个 LineID 枚举，我们有一个工具可以将其与API的有效路线列表进行比较。它报告 LineID 的状态，列出哪些线路缺失，哪些有不匹配的 to_string() 映射，以及哪些不再使用。

APP_KEY=hjdhajsdas cargo run --bin line-id-check