README.md

shipbob

A fully generated, opinionated API client library for ShipBob.

API Details

ShipBob Developer API Documentation

Authentication

Client Details

This client is generated from the ShipBob OpenAPI specs based on API spec version 1.0. This way it will remain up to date as features are added. 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]
shipbob = "0.8.0-rc.1"

Basic example

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

use shipbob::Client;

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

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

• SHIPBOB_API_KEY

And then you can create a client from the environment.

use shipbob::Client;

let shipbob = Client::new_from_env();