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

Add Swagger API Documentation #8

Open
GautamAnjali569 opened this issue Jan 25, 2025 · 0 comments
Open

Add Swagger API Documentation #8

GautamAnjali569 opened this issue Jan 25, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation IWOC2025 Medium

Comments

@GautamAnjali569
Copy link
Member

Description

Enhance the project with Swagger documentation for all existing API endpoints to provide an interactive, user-friendly interface for developers.

Steps to Implement

  1. Install swagger-ui-express and swagger-jsdoc.
  2. Create an OpenAPI specification for all routes, including parameters, request bodies, and responses.
  3. Serve the Swagger UI at /api-docs for interactive API documentation.

Expected Outcome

API documentation is available, making it easier for developers to understand and test the API.
@Durgesh4993 Durgesh4993 added documentation Improvements or additions to documentation Medium IWOC2025 labels Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation IWOC2025 Medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Durgesh4993 @GautamAnjali569