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

Enhancement - Add comments before routes for the Open API Spec #16

Open
khareyash05 opened this issue Oct 10, 2023 · 0 comments
Open

Enhancement - Add comments before routes for the Open API Spec #16

khareyash05 opened this issue Oct 10, 2023 · 0 comments

Comments

@khareyash05
Copy link

Hi ! I am in touch with this project from quite a while now and I had been reading about Open API recently. Would you like to OpenAPI-fy your project?

From my (limited) knowledge of Golang, there's no easy way to generate the Spec file without adding the comments before routes through the project.

Would it make sense to introduce something like this through the codebase so the file is auto generated?There would still be scope for error since the file isn't generated automatically from the code (which from what I can tell is not possible in Golang), but would make it slightly easier to track and make changes vs making them directly in the spec file.

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

1 participant