feat(swagger): add swagger settings to the project

Refs #94

backend/src/main/config/swaggerConfig.ts

@@ -0,0 +1,43 @@
+import { Express } from "express";
+import swaggerJSDoc from "swagger-jsdoc";
+import swaggerUi from "swagger-ui-express";
+
+const options = {
+  definition: {
+    openapi: "3.0.0",
+    info: {
+      title: "API Documentation",
+      version: "1.0.0",
+      description: "API documentation for the project",
+    },
+    servers: [
+      {
+        url: "http://localhost:8000",
+      },
+      {
+        url: "https://your-app-name.onrender.com",
+      },
+    ],
+    components: {
+      securitySchemes: {
+        bearerAuth: {
+          type: "http",
+          scheme: "bearer",
+          bearerFormat: "JWT",
+        },
+      },
+    },
+    security: [
+      {
+        bearerAuth: [],
+      },
+    ],
+  },
+  apis: ["./src/**/*.ts"], // Caminho para os arquivos que contêm as anotações JSDoc
+};
+
+const swaggerSpec = swaggerJSDoc(options);
+
+export const setupSwagger = (app: Express): void => {
+  app.use("/docs", swaggerUi.serve, swaggerUi.setup(swaggerSpec));
+};

backend/src/server.ts

@@ -2,6 +2,7 @@ import categoryRoutes from "./main/routes/category/categoryRoutes";
 import cors from "cors";
 import dotenv from "dotenv";
 import express from "express";
+import { setupSwagger } from "./main/config/swaggerConfig";
 import transactionRoutes from "./main/routes/transaction/transactionRoutes";
 import userRoutes from "./main/routes/user/userRoutes";
 
@@ -17,6 +18,8 @@ app.use(userRoutes);
 app.use(categoryRoutes);
 app.use(transactionRoutes);
 
+setupSwagger(app);
+
 app.listen(PORT, () => {
   console.log(`Server running on http://localhost:${PORT}`);
 });