Tie frontend and backend together by typing the REST routes - #257
Merged
Conversation
Signed-off-by: Stefan Marr <git@stefan-marr.de>
This covers mostly the routes needed for the frontend. Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
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.
This PR introduces static type checking for REST routes.
At the server side, routes are now registered with the
defineRoute()function.The client, i.e., frontend can access them with the
apiFetch()function.Both rely on the
ApiRoutestype, which allows us to connect the route to a specific response type, which we define inshared/routes.ts.ApiRoutesis the precise type, whileapiRoutesis the object available at run time, for instance to act based on the specific HTTPmethod.