[FEATURE]: Swagger Documentation

[dsousa12]

Summary

Implementation of Swagger documentation.

Notes

• Install swagger-ui-express and @nestjs/swagger;
• Add configurations on main.ts;

  const config = new DocumentBuilder()
     .setTitle('SPLIT')
     .setVersion('0.0.1')
     .build();
  
   const document = SwaggerModule.createDocument(app, config);
  
   SwaggerModule.setup('swagger', app, document);

• Add params, body and summary decorators to:
  • Auth Module
  • Azure Module
  • Boards Module
  • Cards Module
  • Comments Module
  • Teams Module
  • Users (only DTOs - don't have controller)
  • Votes Module
• Set responses schemas and types:
  • Auth Module
  • Azure Module
  • Boards Module
  • Cards Module
  • Comments Module
  • Teams Module
  • Votes Module
• Add tags
  • Authentication;
  • Boards;
  • Teams;
  • Votes;
  • Comments;
• Default Errors Responses
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 500 - Internal Server Error

Motivation

With Swagger the new members and frontend developers can see which endpoints exists on backend, can test that endpoints and see the possible responses/status code.

[CatiaBarroco-xgeeks]

for me it seems really good, I agree with this implementation

[dsousa12]

Note:

After MVP it's necessary refactoring all DTO's to have separated DTO's to creation methods (without _id).