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

[docs] - Swagger Open API documentation #19

Open
dave-ok opened this issue Jun 2, 2020 · 0 comments
Open

[docs] - Swagger Open API documentation #19

dave-ok opened this issue Jun 2, 2020 · 0 comments
Labels
back-end Backend Issues documentation Improvements or additions to documentation feature A new feature

Comments

@dave-ok
Copy link
Member

dave-ok commented Jun 2, 2020 •
edited
Loading

Description

To enable end users/API consumers know available endpoints, relevant parameters, valid data and their types, url and request methods we need a documentation for the API.

This API documentation will be generated using swagger tools, particularly swagger-jsdoc and swagger-ui-express and will be hosted on /api-docs. Alternative API documentation tools can be used.

Support Articles:
@dave-ok dave-ok added documentation Improvements or additions to documentation feature A new feature back-end Backend Issues labels Jun 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
back-end Backend Issues documentation Improvements or additions to documentation feature A new feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dave-ok