Backend Client

Beschreibung

Um die API von unserem Backend ansprechen zu können, wird automatisch ein Backend Client generiert. Das Backend stellt seine Api Definition über Swagger zur Verfügung (siehe backend/swagger). Swagger bzw. OpenAPI stellt einen Codegenerator zur Verfügung, um aus der Swagger-Api-Definition einen Client in verschiedenen Sprachen zu generieren. Uns interessiert die Eigenschaft, dass der Generator die Definitionen in TypeScript generiert.

Backend Client generieren

Es steht ein Skript zur Verfügung, das einen Backend Client generiert. Der Backend Client wird in einem separaten Workspace im Ordner backen-client generiert. Der Client kann wie folgt erstellt werden

yarn generate # erstellt einen Backend Client vom dev deployment (app.dev.green-ecolution.de)
yarn generate:local # erstellt einen Backend Client von einer lokalen Backend instanz (localhost:3000)

Was macht das Skript?

Das Skript Downloaded die Swagger Definition vom Backend herunter und erstellt den Backend CLient in TypeScript in einem eigenen Workspace. Dieser kann nun vom Frontend verwendet werden. Sollte sich die API vom Backend ändern, kann das Skript erneut ausgeführt werden und der Client für das Backend ist wieder aktuell, ohne den Code anzufassen.