Backend Client

Was macht der Backend Client

Um die Api von unseren Backend ansprechen zu können, wird automatisiert ein Backend Client generiert. Das Backend stellt seine Api Definition über swagger zu verfügung (siehe backend/swagger). Swagger bzw. OpenAPI stellt eine Code Generator zur Verfügung, um durch die Swagger Api Definition einen Client in unterschiedlichen Sprachen zu generieren. Uns interessiert dabei die Eigenschaft, dass der Generator die Definitionen in TypeScript geneiert.

Backend Client generieren

Es steht ein Skript zur Verfügung, welches einen Backend Client generiert. Der Backend Client wird in einem seperaten Workspace in dem 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)