Skip to content
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

Generate typescript definitions for client with OpenAPI/swagger specs #169

Open
dominictwlee opened this issue Nov 12, 2022 · 2 comments
Open

Comments

@dominictwlee
Copy link

dominictwlee commented Nov 12, 2022

Any plans to generate typescript definitions with swagger/openAPI specs? I think this would be super handy and would speed up development for client implementations.

Could use something like https://github.com/drwpow/openapi-typescript

@simonv3
Copy link
Collaborator

simonv3 commented Nov 12, 2022

I hadn't even considered that this would be possible but it would be great!

For what it's worth (and I posted this in the mattermost too) I'm standardizing a bunch of the API requests so that they consistently return the same info or info format, right now that's a bit all over the place. But it probably means some changes to the formats you're receiving, which I realize is frustrating. I was thinking it makes more sense to do this now before the API is live than to have to actually maintain proper versioning on the API afterwards.

Generating the typescript automatically would help with that massively I think. I'll look into it!

@dominictwlee
Copy link
Author

dominictwlee commented Nov 12, 2022

yeah cool no worries, not too much effort on my part!

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

No branches or pull requests

2 participants