Flexport API v2 Sandbox

This projects provides a sandbox host using data scraped from a sandbox instance of the Flexport API v2.

It can be used to run integration tests.

Development

ℹ️ These instructions apply to Unix-based development environments; Linux and Mac users should be fine. Windows users could look into setting up their development environment using WSL2.

Usage

npm ci
npx tsc
npm start # Starts the sandbox server at port 3000

You can now query against http://0.0.0.0:3000, e.g. http http://0.0.0.0:3000/shipments.

Updating the files

export SANDBOX_API_ENDPOINT=<...>
export SANDBOX_API_KEY=<...>
node dist/sandbox-dumper.js