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
docs/docs/tsclient.md
Samuel Paccoud - DINUM 62df0524ac (project) first proof of concept printing pdf from markdown
This is a boilerplate inspired from https://github.com/openfun/joanie
2024-01-09 15:30:36 +01:00

739 B

Api client TypeScript

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

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