docs/docs/tsclient.md

Api client TypeScript

The backend application can automatically create a TypeScript client to be used in frontend applications. It is used in the impress front application itself.

This client is made with openapi-typescript-codegen and impress's backend OpenAPI schema (available here if you have the backend running).

Requirements

We'll need the online OpenAPI schema generated by swagger. Therefore you will first need to install the backend application.

Install openApiClientJs

$ cd src/tsclient
$ yarn install

Generate the client

yarn generate:api:client:local <output_path_for_generated_client>