1 个不稳定版本

0.1.0 2023 年 9 月 13 日

#29 in #http-framework

MIT 许可证

23KB
394

Argos

Argos 使创建独立的网络应用后端服务器变得容易。

用法

简单示例

步骤 1:定义你的 API 函数

您可以使用宏属性定义您的 api 函数

#[route(GET, path = "/api/hello", formatter = "text")]
pub fn hello(req: HttpRequest) -> Result<String, ReturnError<String>> {
    let url_params = req.url_params();
    let name = url_params.get("name");
    match name {
        Some(name) => Ok(format!("hello {}!", name)),
        None => Err(
            ReturnError::new(
                400,
                "name is required".to_string(),
            )
        ),
    }
}

此函数定义了一个使用 GET 方法的 http 接口,URL 路径为 /api/hello

步骤 2:启动服务器

您可以使用以下方式启动您的服务器

#[tokio::main]
async fn main() {
    let server = Server::builder(([127, 0, 0, 1], 3000).into())
        .build()
        .await
        .unwrap();
    server.start().await.unwrap();
}

您的服务器将绑定在 127.0.01:3000,因此您可以发送 http 请求来调用此 API

curl http://127.0.0.1:3000/api/hello?name=liudao

过滤器

您可以定义一个过滤器来过滤请求

#[filter(path_pattern="/api/hello.*", order=1)]
pub fn path_filter(mut req: HttpRequest) -> Chain {
    let attr = req.attributes_mut();
    attr.insert("kk".to_string(), "value".to_string());
    // let _method = req.method_mut();
    if req.headers().contains_key("token") {
        Chain::Continune(req)
    } else {
        let mut return_err = ReturnError::new(
            401, 
            "not authorized".to_string(),
        );
        return_err.headers.append("filter", HeaderValue::from_str("rejected").unwrap());
        Chain::Reject(return_err)
    }
    
}

过滤器目前仅支持 path_pattern,使用 regexp。属性 order 表示过滤器的优先级,数字越小,优先级越高。

core/examples 中查看更多示例。

许可证

Argos 在 MIT 许可证下提供。请参阅 LICENSE

依赖项

~305–760KB
~18K SLoC