ci(frontend-store): generate frontend API client from committed OpenAPI contract#185
Open
spah-soptim wants to merge 1 commit into
Conversation
The frontend now calls the backend through a typed client generated by @hey-api/openapi-ts from the backend's OpenAPI spec. The generated client (frontend/src/lib/api/generated) is git-ignored and was produced from a running backend at localhost:8080, so frontend build, lint and the Docker image had no way to obtain it in CI. Commit the spec as a contract and generate the client offline from it: - Backend: add gated OpenApiSpecExportTest (-Dopenapi.export=true) that writes a deterministic frontend/openapi.json (sorted keys, sorted required arrays, fixed newline, servers stripped). Skipped by default. - Frontend: openapi-ts.config.ts reads ./openapi.json by default, override with OPENAPI_INPUT for live-backend generation; ignore the spec and generated client in prettier; generate the client in the Dockerfile. - CI: frontend-ci and publish-test-images generate the client after install; backend-ci re-exports the spec and diff-checks it so the committed contract can never drift from the controllers.
Member
Author
|
@tarn-soptim, added generation for the openapi spec and implemented in backend ci that it fails if out of date. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The frontend now calls the backend through a typed client generated by @hey-api/openapi-ts from the backend's OpenAPI spec. The generated client (frontend/src/lib/api/generated) is git-ignored and was produced from a running backend at localhost:8080, so frontend build, lint and the Docker image had no way to obtain it in CI.