@0xproject/sra-api
Contains the Standard Relayer API OpenAPI Spec.
The package distributes both a javascript object version and a json version.
Usage
import { api } from '@0xproject/sra-api';
Installation
yarn install
Development
You can start a development server that will serve a ReDoc documentation instance. It uses the api.json file from lib/ (you must have built at least once with yarn build or yarn build-json) that is based on the api object exported from src.
yarn develop
The process will watch for changes, but will not hot-reload so you must refresh the page to see the changes.
Contributing
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
Please read our contribution guidelines before getting started.
Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0xproject/sra-api yarn build
Or continuously rebuild on change:
PKG=@0xproject/sra-api yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test