-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ENG-1497 Feat: Codegen implementation in api package #33
Merged
Conversation
This file contains 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
ENG-1497 [Spike] Setup codegen with OpenAPI
TLDR: Use the openapi.json to generate models, types, and API calls on the front-end Context https://intuition-systems.slack.com/archives/C070UVDVB5X/p1715355180943489 |
rahulr8
changed the title
ENG-1497: Codegen proof of concept
ENG-1497 Feat: Codegen proof of concept
May 13, 2024
rahulr8
changed the title
ENG-1497 Feat: Codegen proof of concept
ENG-1497 Feat: Codegen implementation in api package
May 22, 2024
rahulr8
requested review from
jonathanprozzi,
alexander-mann,
Vitalsine85 and
0xjojikun
May 23, 2024 00:14
0xjojikun
approved these changes
May 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Affected Packages
Overview
This PR setups a library under
packages/api/api-client
that contains the Typescript client to interface with the backend. There are two generated files that are of particular importanceservices.gen.ts
- All API calls to the backend wrapped in functions and usingaxios
types.gen.ts
- TypeScript interfaces to model data from the backendThese can be imported into any
app
orpackage
in the mono-repo in order to better facilitate seamless interfacing with the backend.Testing
Run
pnpm install
to install latest dependencies.For testing, I created a
test
route which you can hit. It has the following loader. You can go tolocalhost:3000/test
to access it and check your server logs.You should see the following logs
Declaration