Implement Swagger for API Documentation and Testing

[vincedotcode]

Feature Request

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like I would like to propose the addition of Swagger to the project to enable better API documentation and testing. Swagger, also known as OpenAPI, provides a set of tools for designing, building, and documenting RESTful APIs. Implementing Swagger can help both new and existing contributors to understand and test the API endpoints more efficiently.

Describe alternatives you've considered Any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here. If the project has many endpoints, a Swagger implementation would make it significantly easier to manage the API documentation and ensure it stays up-to-date as the project evolves.

Implementing Swagger could bring the following benefits:

• Interactive documentation: Developers can visualize and interact with the API’s resources without having any of the implementation logic in place.
• Client SDK generation: Swagger can drive the API development and it can also be used to generate client libraries.
• Testing: Easy testing of APIs right from the browser.

I believe adding Swagger will be a great value-add to the project and can make the development process more efficient.

Thank you for considering this enhancement.

[BalesabuGodugu]

@vincedotcode could you please assign to me this feature, I would like to implement it

[BalesabuGodugu]

team i am working on this issue. please assign on my name

[vincedotcode]

@salahlalami Would you be able to assign this feature to me and @BalesabuGodugu as well

We'll plan this as a user story and break it down into multiple tasks accordingly

[239yash]

@vincedotcode @salahlalami I also want to contribute to this feat, Let me know, If I can work on this

[239yash]

@vincedotcode I have added a base setup for swagger. We need to add documentation for request, response type and other details.