#api-client #user #generated #opinionated #set #most #rippling

rippling-api

A fully generated & opinionated API client for the Rippling API

4 releases

new 0.1.3 Sep 17, 2024
0.1.2 Aug 30, 2024
0.1.1 Aug 30, 2024
0.1.0 Aug 11, 2024

#56 in Email

Download history 89/week @ 2024-08-06 26/week @ 2024-08-13 228/week @ 2024-08-27 3/week @ 2024-09-03

306 downloads per month

MIT license

495KB
16K SLoC

rippling-api

A fully generated & opinionated API client for the Rippling API.

docs.rs

API Details

Documentation for the Rippling Platform API.

Client Details

The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
rippling-api = "0.1.3"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use rippling_api::Client;

let client = Client::new(
    String::from("api-key"),
);

Alternatively, the library can search for most of the variables required for the client in the environment:

  • RIPPLING_API_TOKEN

And then you can create a client from the environment.

use rippling_api::Client;

let client = Client::new_from_env();

lib.rs:

A fully generated & opinionated API client for the Rippling API.

docs.rs

API Details

Documentation for the Rippling Platform API.

Client Details

The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
rippling-api = "0.1.3"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use rippling_api::Client;

let client = Client::new(String::from("api-key"));

Alternatively, the library can search for most of the variables required for the client in the environment:

  • RIPPLING_API_TOKEN

And then you can create a client from the environment.

use rippling_api::Client;

let client = Client::new_from_env();

Dependencies

~23–38MB
~395K SLoC