Skip to content

Migrate SDK generator to hey-api #1

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

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Migrate SDK generator to hey-api #1

wants to merge 4 commits into from

Conversation

StableCrimson
Copy link
Owner

@StableCrimson StableCrimson commented Apr 19, 2025

There is pretty much no way to avoid a breaking change. Draft PR on personal fork while I work out the details.

hey does not have full feature parity with the openapi generator, so we can't migrate this without a breaking change. My idea is to make the generation as close to the current output as possible, and then slowly move toward the hey-style output so we can take advantage of things like tree shaking.

Key Differences

  • Classes and models don't live in individual files. There is an issue open (and a few closed ones) asking about adding this.
  • All class methods are static. No need to create or manage instances. There is a feature PR open that will allow for us to configure that.
  • Config (such as auth key and base URL) can be stored in the generated client singleton and doesn't need to be passed around. Though this issue is open and is a feature that's on the roadmap.
  • No JSDOC tags are generated. There's an issue showing interest in its implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant