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

OpenAPI Specification #35

Open
redxtech opened this issue Jun 29, 2023 · 2 comments
Open

OpenAPI Specification #35

redxtech opened this issue Jun 29, 2023 · 2 comments

Comments

@redxtech
Copy link

Hey!

This looks like a really useful tool, and I'm going to be using it for the API I'm currently working on.

I'm also looking for something to create an OpenAPI document for the API, and it looks like there are a few libraries out there for that at the moment, but none of them allow you to define everything in the router.

Would it be possible to add functionality to be able to generate an entire OpenAPI document from a router object? That would be super useful!

If there's already some way that I can accomplish this, that would also be great!

Thanks :)

@JakeFenley
Copy link
Owner

JakeFenley commented Jun 29, 2023

Hi @redxtech

Glad you're finding this lib useful :)

I have thought about adding some kind of OpenAPI generation, but I haven't really dug too deep into it.

There is another library similar to this express-zod-api that does this I believe.

I'm pretty busy lately and I honestly couldn't tell you when/if I'd be adding this, but I'd be happy accepting a PR for this.

@redxtech
Copy link
Author

That sounds good!

I probably won't get to it right away either, but when I get to the stage where I need to create the OpenAPI schema, I'll definitely look into extending this and adding a PR.

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