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

Set up swagger for the backend API #18

Open
SarahBornais opened this issue Feb 14, 2023 · 0 comments
Open

Set up swagger for the backend API #18

SarahBornais opened this issue Feb 14, 2023 · 0 comments
Assignees
Labels

Comments

@SarahBornais
Copy link
Member

This issue depends on issue #17 (set up backend endpoints). Let's see if we can use swagger to document our backend API. Swagger automatically generates API documentation that can normally be viewed by running the backend application and navigating to a /api-docs endpoint. I haven't integrated it with Node.js before, but it seems doable (see swagger-ui-express).

@allwelly allwelly self-assigned this Mar 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants