-
-
Notifications
You must be signed in to change notification settings - Fork 102
Doc comments + GET query params #93
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
Conversation
This is an interesting idea, thanks for sharing it with us and everyone else who uses the package! @tomirons what do you think mate? There are a few minor things I'd change like renaming |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the concept of this feature.
For this to be merged, some tests will need to be written.
I've added some tests for the get request as well as the doc comment generation. |
Great updates, thank you @Menkveld-24! I've been running into that issue too, it used to show up locally but not when running GitHub actions, so not sure what that's about. cc @tomirons 🤔 StyleCI appears to be failing but that's quite minor. |
Hi.
I had this bit of code for my own project and was wondering what might be of use to merge into your main repository.
I added so that if you have a request scheme for a get request that it'd show up as query parameters instead of at the body.
I also added that comments above the functions/route handlers in controllers we're added as 'documentation' to the postman route (useful for sharing the api documentation internally with colleagues e.g.).
Haven't written any tests for this. I'll refine this along with tests if you think any of these 2 features is useful.
Kind regards,
Menke
The query params on a get request.
The documentation (comment above the function)