🚀 Feature: Backend documentation with Swagger

[yurimutti]

🔖 Feature description

We must enhance our API documentation to understand and integrate new partners more easily.

🎤 Why is this feature needed ?

We need to add clarity and coverability to our API.

Example:

What is material array of string?

"materials": [
   "string"
 ],

Payload example:

"materials": [
    {
      "materialType": "PLASTIC",
      "weightKg": 5.2
    },
    {
      "materialType": "METAL",
      "weightKg": 3.8
    }
  ],

What materialType we can use ?

export enum ResidueType {
  GLASS = 'GLASS',
  METAL = 'METAL',
  ORGANIC = 'ORGANIC',
  PAPER = 'PAPER',
  PLASTIC = 'PLASTIC',
  TEXTILE = 'TEXTILE',
  LANDFILL_WASTE = 'LANDFILL_WASTE',
}

✌️ How do you aim to achieve this?

Review all DTOs, and schema, improve him, create global entities for users, reports, etc

Add correctly decorators @ApiTags, @ApiOperation, @ApiResponse e @ApiParam

Search and add Swagger best practices and improvements

🔄️ Additional Information

https://staging.api.recy.life/docs#/recycling-reports/RecyclingReportController_createRecyclingReport

👀 Have you spent some time to check if this feature request has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Contributing Guidelines

Are you willing to submit PR?

None