BE: Initialize Swagger API Documentation

[onlydustapp]

📚 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! 🚀

[KuchiMercy]

Hi, I'm Mercy. I'd like to work on this.
Kindly assign.

[solowiseCV]

Application for Swagger/OpenAPI Integration

• I'm eager to contribute by integrating and configuring Swagger/OpenAPI in your NestJS application. With my experience in API documentation, NestJS, and OpenAPI standards, I can ensure a well-structured and maintainable API documentation system.

Why I'm a Strong Fit

NestJS & Swagger Expertise – Proficient in using @nestjs/swagger to generate dynamic API documentation.

Scalability & Maintainability – Ensuring the documentation structure supports future expansion as new modules are added.

Production-Ready API Docs – Experience validating Swagger configurations across development and production environments.

Relevant Experience

BudgetChain (Blockchain & Finance) – Designed API documentation for treasury, budgeting, and reporting modules.

Cue (Travel Platform) – Integrated Swagger UI for trip booking, lodging, and user management APIs.

Implementation Plan

Integrate @nestjs/swagger – Install and configure it within the NestJS project.

Define API Documentation Structure – Organize endpoints into auth, treasury, budget, AI, blockchain, reporting, and user management.

Auto-Generate Documentation – Ensure Swagger dynamically reflects all endpoints.

Provide Usage Examples – Document request/response structures and authentication flows.

Validate Across Environments – Test the documentation in dev and production setups.

Add Maintenance Instructions – Guide on updating and expanding the API docs as the project evolves.

[laryhills]

Comment:

Hi, I’m Hilary , a full stack developer with experience with NestJS, and I’m excited to work on this task!

For this task, I will:

•	Integrate and configure @nestjs/swagger with the existing NestJS framework.
•	Organize the API documentation structure to ensure scalability and maintainability.
•	Ensure all modules (auth, treasury, budget, AI, blockchain, reporting, and user management) are dynamically documented.
•	Create initial API documentation with core endpoint details and usage examples.
•	Validate the setup in both development and production environments.
•	Follow the existing project dependencies and coding standards outlined in the BudgetChain Backend README.
•	Provide clear instructions for updating and maintaining the API documentation.

Estimated Completion Time:

•	2-3 days

Testing Plan:

•	Verify that Swagger/OpenAPI is accessible and correctly integrated.
•	Ensure documentation auto-generates based on available endpoints.
•	Validate that all core endpoints are documented with proper usage instructions.
•	Confirm seamless integration within the NestJS setup.

[deedee-code]

Hi, my name is Doris Owoeye, a Backend Developer with experience working with expressjs and nestjs. I will like to work on this task.

ETA: 24hrs

[nilaygit-10721]

I’d like to resolve this.

[Spycall]

Hey team i’d like to take on setting up swagger for the budgetchain backend. i’ll integrate @nestjs/swagger into our current nestjs project and make sure it plays nice with our structure—everything inside src/modules/ like auth, treasury, budget, ai, blockchain, reporting, and user. the idea is to auto-generate docs from the decorators and keep it scalable so as modules grow, the docs stay clean and up-to-date. i’ll follow the repo standards: use typescript fully, stick to our folder conventions, keep everything formatted with prettier/eslint, and document the setup clearly in the readme. i’ll test the config in both dev and prod environments, and once it’s live, the api docs will be available at something like http://localhost:3000/api while running npm run start:dev. i’ll also include examples for the main routes and write down how future contributors can add/update docs without breaking the structure. this will make our backend way easier to use for frontend folks and any third-party devs. i’ll work off a feature/swagger-docs branch and raise a clean pr once everything’s working smoothly. ready to start as soon as i get the nod