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

Document API via annotations #53

Open
cormander opened this issue Apr 18, 2020 · 2 comments
Open

Document API via annotations #53

cormander opened this issue Apr 18, 2020 · 2 comments

Comments

@cormander
Copy link

As a developer I want to document the API endpoints in-line to the code so that I can easily keep the API documentation up to date and so that people integrating with the API can do so easily.

This feature is done when:

  • A framework to annotate node.js code is chosen
  • Basic documentation of each endpoint is completed.
@cormander
Copy link
Author

This looks interesting: https://www.npmjs.com/package/swagger-ui-express

@cormander
Copy link
Author

Initial commit e9d23f9

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