Non-Permeable Membrane

    @0x/sra-spec
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.9 • Public • Published

    @0x/sra-spec

    Contains the Standard Relayer API OpenAPI Spec.

    The package distributes both a javascript object version and a json version.

    A deployed ReDoc static site with the API can be found here http://sra-spec.s3-website-us-east-1.amazonaws.com/.

    Usage

    import { api } from '@0x/sra-spec';
    

    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 watch_without_deps
    

    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=@0x/sra-spec yarn build

    Or continuously rebuild on change:

    PKG=@0x/sra-spec yarn watch

    Static Site

    We also host a static HTML version of the docs on S3 for easy sharing.

    To build and deploy the site run

    yarn deploy-site
    

    NOTE: On deploying the site, it will say the site is available at a non-existent URL. Please ignore and use the (now updated) URL above.

    Clean

    yarn clean

    Lint

    yarn lint

    Run Tests

    yarn test

    Keywords

    none

    Install

    npm i @0x/sra-spec

    DownloadsWeekly Downloads

    87

    Version

    3.0.9

    License

    Apache-2.0

    Unpacked Size

    135 kB

    Total Files

    85

    Last publish

    Collaborators

    • tobernguyen
    • dex_tracker
    • shawnxin89
    • dekz
    • dorothy-zbornak
    • mzhu25
    • amirbandeali
    • phil-ociraptor