Elaborate Express server endpoints from postman collection

[vaibhavyadav-dev]

Description:

We need to improve the documentation of the BharatSeva Express Server's API by converting and elaborating the existing Postman collection into Swagger (OpenAPI) documentation.

Task Breakdown:

1. Export the Postman collection for the BharatSeva Express Server.
2. Create a new Swagger YAML/JSON file based on the Postman endpoints.
3. Document each endpoint with details such as:
   • Endpoint URL
   • HTTP Method
   • Parameters (Query, Path, Body)
   • Request Body Example
   • Response Body Example
   • Status Codes
   • Description of the endpoint
   • Add usage examples for each endpoint.
4. Ensure that the Swagger documentation is accessible and hosted (could be on GitHub Pages or any other suitable hosting).
5. Test the Swagger documentation for completeness and accuracy.
6. Update the README with instructions on how to access the Swagger UI and Postman collection.
7. After converting, make sure there is still an accessible link to the Postman collection for anyone who prefers using it for testing.
8. Optionally, automate updates between Postman and Swagger documentation (if feasible)

If you want to take this issue elaborate how you are going to approach this task, do you've any prior experience in developing and testing with APIs.