This repository has been archived on 2026-03-24. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
people/docs/tsclient.md
Samuel Paccoud - DINUM eeec372957 (project) first proof of concept based of Joanie
Used https://github.com/openfun/joanie as boilerplate, ran a few
transformations with ChapGPT  and adapted models and endpoints to
fit to my current vision of the project.
2024-01-03 16:31:08 +01:00

737 B

Api client TypeScript

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

This client is made with openapi-typescript-codegen and People'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>