ngrok-rust

API文档（主）

ngrok是一个简化的以API为中心的入口即服务，它为您的应用添加了连接性、安全性和可观测性。

ngrok-rust，我们为将公共互联网地址以安全的入口流量直接添加到您的Rust应用中而设计的本地化和惯用crate。如果您之前使用过ngrok，可以将ngrok-rust视为打包成Rust crate的ngrok代理。

ngrok-rust让开发者在单行语句中即可在互联网上提供服务Rust服务，无需设置IP、NAT、证书、负载均衡器，甚至端口等低级网络原语！使用ngrok-rust的应用程序监听ngrok的全局入口网络中的TCP和HTTP流量。ngrok-rust监听器与hyper服务器兼容，连接实现了tokio的AsyncRead和AsyncWrite特质。这使得它很容易将ngrok-rust添加到任何基于hyper构建的应用程序中，例如流行的axum HTTP框架。

请参阅/ngrok/examples/中的示例用法，或/ngrok/src/online_tests.rs中的测试。

有关使用ngrok API的信息，请参阅ngrok Rust API客户端库。

如果您正在寻找代理包装器，请访问这里。有关迁移的建议，请参阅UPGRADING.md。

有关更多信息，请务必查看ngrok-rust发布公告！

安装

将 ngrok 添加到您的 [dependencies] 部分 Cargo.toml

...

[dependencies]
ngrok = "0.13"

...

或者，使用 cargo add

$ cargo add ngrok

快速入门

使用 ngrok 和 axum 创建简单的 HTTP 服务器

Cargo.toml:

[package]
name = "ngrok-axum-example"
version = "0.1.0"
edition = "2021"

[dependencies]
ngrok = { version="0.13", features=["axum"] }
tokio = { version = "1.26", features = ["full"] }
axum = "0.6"
anyhow = "1.0"

src/main.rs:

use std::net::SocketAddr;

use axum::{
    extract::ConnectInfo,
    routing::get,
    Router,
};
use ngrok::prelude::*;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // build our application with a single route
    let app = Router::new().route(
        "/",
        get(
            |ConnectInfo(remote_addr): ConnectInfo<SocketAddr>| async move {
                format!("Hello, {remote_addr:?}!\r\n")
            },
        ),
    );

    let tun = ngrok::Session::builder()
        // Read the token from the NGROK_AUTHTOKEN environment variable
        .authtoken_from_env()
        // Connect the ngrok session
        .connect()
        .await?
        // Start a tunnel with an HTTP edge
        .http_endpoint()
        .listen()
        .await?;

    println!("Tunnel started on URL: {:?}", tun.url());

    // Instead of binding a local port like so:
    // axum::Server::bind(&"0.0.0.0:8000".parse().unwrap())
    // Run it with an ngrok tunnel instead!
    axum::Server::builder(tun)
        .serve(app.into_make_service_with_connect_info::<SocketAddr>())
        .await
        .unwrap();

    Ok(())
}

变更日志

ngrok-rust 的更改记录在 CHANGELOG.md 中。

加入 ngrok 社区

• 查看我们的官方文档 我们的官方文档
• 在我们的博客上了解更新 我们的博客
• 提交 问题 或 拉取请求
• 加入我们的 Slack 社区
• 在 X / Twitter (@ngrokHQ) 上关注我们
• 订阅我们的 Youtube 频道 (@ngrokHQ)

许可

此项目根据您的选择受以下任一许可的约束

• Apache License，版本 2.0，(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)

。

贡献

除非您明确声明，否则任何旨在包含在 ngrok 中的贡献，根据 Apache-2.0 许可证的定义，均应按上述方式双许可，不附加任何额外条款或条件。