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

Create initial Open API yml file #34

Closed
mattrbianchi opened this issue May 5, 2020 · 2 comments
Closed

Create initial Open API yml file #34

mattrbianchi opened this issue May 5, 2020 · 2 comments

Comments

@mattrbianchi
Copy link
Contributor

Until a tool is found to allow us to auto-generate the file from code, manually create the Open API file to assist in documentation of the services API. Use PR #17 as a reference but update to reflect the current endpoints.
@mattrbianchi mattrbianchi added this to the Sprint 2 milestone May 5, 2020
@rotsen91
Copy link
Contributor

rotsen91 commented May 5, 2020 •
edited
Loading

Check this out. We ended up using swagger-ui-express with swagger-jsdoc. It has a bit of a learning curve if your not used to writing yml lines, but once you get the gist of it, its straight forward from there. Its been working great for us.

@mattrbianchi
Copy link
Contributor Author

Thanks @rotsen91, that looks like exactly what I've been looking for!

@mattrbianchi mattrbianchi modified the milestones: Sprint 2, Sprint 3 May 11, 2020
@mattrbianchi mattrbianchi removed this from the Sprint 3 milestone May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mattrbianchi @rotsen91