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.

Sign up for GitHub

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

Jump to bottom

API documentation generation #3

Closed
hagopj13 opened this issue Nov 22, 2019 · 6 comments · Fixed by #12
Closed

API documentation generation #3

hagopj13 opened this issue Nov 22, 2019 · 6 comments · Fixed by #12
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@hagopj13
Copy link
Owner

hagopj13 commented Nov 22, 2019 •
edited
Loading

It would be nice if we could create API documentation from certain annotations in the source code
@hagopj13 hagopj13 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Nov 22, 2019
@austin047
Copy link

How do i help?

@hagopj13
Copy link
Owner Author

@austin047 thanks for reaching out! I was looking if someone might want to set up automatic documentation generation for the endpoints. Contributions are welcomed.

@austin047
Copy link

automatic documentation with jsdoc??

@hagopj13
Copy link
Owner Author

@austin047 jsdoc looks good. It would also be nice if it was done with Swagger (there is a swagger-jsdoc library)

@austin047
Copy link

Alright.
I do know about swagger-jsdoc.

you propose we use that??

If in that case we will still have to generate the swagger specification file so developers can have the opportunity of viewing the specifications before it's passed to the swagger UI.

@hagopj13
Copy link
Owner Author

@austin047 let's go for swagger-jsdoc then

@akshayjpatil akshayjpatil mentioned this issue May 10, 2020
Merged
@hagopj13 hagopj13 linked a pull request May 12, 2020 that will close this issue
Added support for swagger-jsdoc swagger UI #12
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added support for swagger-jsdoc swagger UI
2 participants
@austin047 @hagopj13