deboa-0.0.1-alpha.1 has been yanked.

deboa

Description

deboa is a straightforward, non opinionated, developer-centric HTTP client library for Rust. It offers a rich array of modern features—from flexible authentication and serialization formats to runtime compatibility and middleware support—while maintaining simplicity and ease of use. It’s especially well-suited for Rust projects that require a lightweight, efficient HTTP client without sacrificing control or extensibility.

Attention

This release has a major api change. Please check the migration guide for more information.

Features

easily add, remove and update headers
helpers to add basic and bearer auth
set base url only once, change it when needed
request data only by specifying path
set retries and timeout
pluggable middleware
pluggable compression (gzip, deflate, br)
pluggable serialization (json, xml, msgpack)
bora macro to easily create api clients
cookies support
comprehensive error handling
runtime compatibility (tokio and smol)
http1/2 support

Install

deboa = { version = "0.0.5", features = ["http1", "tokio-rt"] }

Crate features

tokio-rt (default)
smol-rt
http1 (default)
http2

Usage

Serialize request and deserialize response using json

use deboa::Deboa;
use deboa_extras::http::serde::json::JsonBody;

let api = Deboa::new("https://jsonplaceholder.typicode.com");

let posts: Vec<Post> = api.get("/posts").await?.body_as(JsonBody)?;

println!("posts: {:#?}", posts);

Serialize request and deserialize response using xml

use deboa::Deboa;
use deboa_extras::http::serde::xml::XmlBody;

let api = Deboa::new("https://xmlplaceholder.fake.com");

let posts: Vec<Post> = api.get("/posts").await?.body_as(XmlBody)?;

println!("posts: {:#?}", posts);

Adding headers

use deboa::Deboa;
use http::header;
use deboa_extras::http::serde::json::JsonBody;

let mut api = Deboa::new("https://jsonplaceholder.typicode.com");
api.add_header(header::CONTENT_TYPE, "application/json");
let posts: Vec<Post> = api.get("/posts").await?.body_as(JsonBody)?;

println!("posts: {:#?}", posts);

Adding bearer auth

use deboa::Deboa;
use http::header;

let mut api = Deboa::new("https://jsonplaceholder.typicode.com");
api.add_bearer_auth("token");
let posts: Vec<Post> = api.get("/posts").await?.body_as(JsonBody)?;

println!("posts: {:#?}", posts);

Adding basic auth

use deboa::Deboa;
use http::header;
use deboa_extras::http::serde::json::JsonBody;

let mut api = Deboa::new("https://jsonplaceholder.typicode.com");
api.add_basic_auth("username", "password");
let posts: Vec<Post> = api.get("/posts").await?.body_as(JsonBody)?;

println!("posts: {:#?}", posts);

Change request base url

use deboa::Deboa;
use deboa_extras::http::serde::json::JsonBody;

let mut api = Deboa::new("https://jsonplaceholder.typicode.com");
api.set_base_url("https://jsonplaceholder.typicode.com");
let posts: Vec<Post> = api.get("/posts").await?.body_as(JsonBody)?;

println!("posts: {:#?}", posts);

Adding middleware

use deboa::{Deboa, DeboaMiddleware};

struct MyMiddleware;

impl DeboaMiddleware for MyMiddleware {
    fn on_request(&self, request: &mut Request) {
        // Do something with the request
    }

    fn on_response(&self, response: &mut Response) {
        // Do something with the response
    }
}

let mut api = Deboa::new("https://jsonplaceholder.typicode.com");
api.add_middleware(MyMiddleware);
let post: Post = api.get("/posts/1").await?.body_as(JsonBody)?;

println!("post: {:#?}", post);

License

MIT

Author

Rogerio Pereira Araujo rogerio.araujo@gmail.com

deboa 0.0.1-alpha.1