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

Setup Swagger UI for the API documentation #12

Open
fatmali opened this issue Dec 13, 2019 · 1 comment
Open

Setup Swagger UI for the API documentation #12

fatmali opened this issue Dec 13, 2019 · 1 comment
Assignees
@maxwelbarno
Labels
chore
Milestone
Sprint 1

Comments

@fatmali
Copy link
Contributor

fatmali commented Dec 13, 2019 •
edited
Loading

We decided to move forward with swagger as most of the team was familiar with it. Swagger also offers Swagger UI which we can use to build a self-hosted sandbox and documentation for free for everyone. The UI can be documented using json and validated using a VSCode extension called Swagger Viewer. Example and tutorial:

https://www.youtube.com/watch?v=qemG0CWOx1I
@fatmali fatmali added the chore label Dec 13, 2019
@fatmali fatmali added this to the Sprint 1 milestone Dec 13, 2019
@maxwelbarno
Copy link
Collaborator

Cool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maxwelbarno maxwelbarno

Labels
chore
Projects
None yet
Milestone
Sprint 1
Development

No branches or pull requests
2 participants
@maxwelbarno @fatmali