Adds API documentation from Swagger

[dayvsonspacca]

The main changes include the creation of a route called /docs, not accessible through the routes / or /:type, which stores the Swagger HTML file responsible for displaying the documentation. Additionally, a new script has been created to automatically generate the swagger.yml file based on what is in the data folder, creating the endpoints.

To generate the file:

npm run gen:swagger

Simply navigate to the /docs endpoint to view the documentation.

It was necessary to disable the Content Security Policy (CSP) in Helmet so that the HTML file can request the necessary CDN files to build the documentation.

The last change was to use lint and format, which resulted in many changes in files that apparently were not formatted previously.

Important to mention that the /boss endpoint was not included in the documentation because as of the current date 02/28/2024, it is not functioning properly.

[dayvsonspacca]

still need all the lints to be undone?

[man90es]

While I generally agree that PRs should focus on one change, I'd let this formatting fix slide. It's a good change to have standardised formatting

[dayvsonspacca]

Now that you brought up these points, this script actually became a bit useless 🙃.

I'll be closing this PR and I'll be thinking about something simpler for this documentation with this tool that you recommended or with the scalar that I've already used and found interesting.

I will come back soon with this documentation 🤙