BE: Initialize Swagger API Documentation

📚 Overview

Implement Swagger API documentation in the BudgetChain Backend project to provide clear and accessible API definitions and usage guidelines.

🛠️ Task Details

• Configure Swagger/OpenAPI:

  • Integrate and configure the @nestjs/swagger module with existing NestJS framework setup.

• Set Up API Documentation Structure:

  • Organize the API documentation structure to ensure it is scalable and maintainable.
  • Ensure that the documentation dynamically reflects all available endpoints and modules (such as auth, treasury, budget, ai, blockchain, reporting, and user management).

• Create Initial API Documentation:

  • Document the core endpoints and provide basic usage examples.
  • Validate the configuration against both development and production environments.

⚙️ Technical Considerations

• Make sure to follow existing project dependencies and coding standards as outlined in BudgetChain Backend README.
• Ensure the configuration seamlessly integrates with the current NestJS setup.
• Provide clear instructions on how to update and maintain the API documentation.

🎯 Definition of Done

1. Swagger/OpenAPI is integrated and configured correctly in the project.
2. The API documentation is accessible and auto-generated based on existing endpoints.
3. Documentation reflects initial core endpoints with usage instructions.
4. Clear setup instructions are added for future maintenance.

Let's get this set up to ensure a better development experience and easier integration for third party developers! 🚀