#api-client #remote #generated #opinionated #user #environment #details

remote-api

A fully generated & opinionated API client for the Remote API

2 releases

new 0.1.2 Jan 22, 2025
0.1.1 Jan 22, 2025

#947 in Web programming

Download history 269/week @ 2025-01-22

269 downloads per month

MIT license

205KB
4.5K SLoC

remote-api

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

docs.rs

API Details

Authentication

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]
remote-api = "0.1.2"

Basic example

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

use remote_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:

  • REMOTE_API_TOKEN

And then you can create a client from the environment.

use remote_api::Client;

let client = Client::new_from_env();

lib.rs:

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

docs.rs

API Details

Authentication

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]
remote-api = "0.1.2"

Basic example

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

use remote_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:

  • REMOTE_API_TOKEN

And then you can create a client from the environment.

use remote_api::Client;

let client = Client::new_from_env();

Dependencies

~24–40MB
~409K SLoC