Skip to content

API Client

Peter Fisher edited this page Oct 9, 2022 · 6 revisions

The API client is a JavaScript package used to make request to the API. The API client contains a Mock API Server that is used for client sided testing.

System requirements

  • Node
  • NPM
  • Yarn

Install guide

  1. Install the packages
yarn install
  1. Run the mock server
yarn start
  1. Generate the OpenAPI TypeScript module Make sure you have already generated the openapi spec file.

See this guide for details

yarn run generate-api 

Testing

yarn run lint
yarn run test

Routes

Clone this wiki locally