#http-api #api-bindings #client #ulule

ulule-client

Client for the Ulule v1 HTTP API

3 releases (1 stable)

1.0.0 Nov 15, 2019
0.1.1 Oct 11, 2019
0.1.0 Oct 9, 2019

#175 in #http-api

MIT license

30KB
382 lines

ulule-client

ulule on crates.io ulule-rust on docs.rs

Rust API bindings for the Ulule v1 HTTP API. This library rely on rust Futures to allow asynchronous usage.

Ulule API documentation

Usage

Put this in Cargo.toml:

[dependencies]
ulule = "1.0.0"
ulule_client = "0.0.3"

and this in the crate root:

extern crate ulule;
extern crate ulule_client;

Test

cargo test

Examples

Run file from examples with:

cargo run --example <example> -- <example flags> <example args>

Getting Started

To get started, create a client:

let client = ulule_client::Client::new();

Search for the last three project created matching the term beer with their owner:

use ulule::search;
use ulule_client::{search_projects, Client};

#[tokio::main]
async fn main() {
    let client = Client::new();
    let p = search::Params::new()
        .limit(2)
        .with_term("beer")
        .with_extra_fields(vec![
            "owner".to_string(),
            "main_tag".to_string(),
            "main_image".to_string(),
        ]);

    let first_page = search_projects(&client, Some(p)).await.unwrap();
    println!("first page: {:?}", first_page);

    if !first_page.meta.has_next() {
        return;
    }

    let second_page = search_projects(&client, first_page.meta.next).await.unwrap();
    println!("second page: {:?}", second_page)
}

Dependencies

~4–9MB
~167K SLoC