✨ feat(server): add swagger

add swagger, swagger ui and file yaml for documenting the api

.vscode/settings.json

@@ -1,5 +1,8 @@
 {
-    "cSpell.words": [
-        "jobify"
-    ]
+  "cSpell.words": [
+    "Calado",
+    "Evandro",
+    "jobify",
+    "openapi"
+  ]
 }

controllers/jobController.js

@@ -22,15 +22,15 @@ export const createJob = async (req, res) => {
 };
 
 export const updateJob = async (req, res) => {
-  const updatedJob = await Job.findByIdAndUpdate(req.params.id, req.body, {
+  await Job.findByIdAndUpdate(req.params.id, req.body, {
     new: true,
   });
 
-  res.status(StatusCodes.OK).json({ msg: "job updated", job: updatedJob });
+  res.status(StatusCodes.OK).json({ msg: "job updated" });
 };
 
 export const deleteJob = async (req, res) => {
-  const deletedJob = await Job.findByIdAndDelete(req.params.id);
+  await Job.findByIdAndDelete(req.params.id);
 
-  res.status(StatusCodes.OK).json({ msg: "job deleted", job: deletedJob });
+  res.status(StatusCodes.OK).json({ msg: "job deleted" });
 };

package.json

@@ -29,6 +29,8 @@
     "mongoose": "^8.1.3",
     "morgan": "^1.10.0",
     "multer": "1.4.5-lts.1",
-    "nodemon": "^3.0.3"
+    "nodemon": "^3.0.3",
+    "swagger-ui-express": "^5.0.0",
+    "yaml": "^2.3.4"
   }
 }

routes/jobRouter.js

@@ -16,7 +16,7 @@ import {
 router.get("/", getAllJobs);
 router.get("/:id", validateIdParam, getOneJob);
 router.post("/", validateJobInput, createJob);
-router.patch("/:id", validateJobInput, validateIdParam, updateJob);
-router.delete("/:id", validateIdParam, deleteJob);
+router.patch("/update/:id", validateJobInput, validateIdParam, updateJob);
+router.delete("/delete/:id", validateIdParam, deleteJob);
 
 export default router;

server.js

@@ -2,9 +2,11 @@ import cookieParser from "cookie-parser";
 import * as dotenv from "dotenv";
 import express from "express";
 import "express-async-errors";
-import { StatusCodes } from "http-status-codes";
+import fs from "fs";
 import mongoose from "mongoose";
 import morgan from "morgan";
+import swaggerUi from "swagger-ui-express";
+import YAML from "yaml";
 
 // middlewares
 import authenticateUser from "./middlewares/authMiddleware.js";
@@ -24,10 +26,10 @@ if (process.env.NODE_ENV === "development") {
   app.use(morgan("dev"));
 }
 
-// index
-app.post("/", (req, res) => {
-  res.status(StatusCodes.OK).json({ message: "Welcome Jobify" });
-});
+// swagger
+const swagger = fs.readFileSync("./swagger.yaml", "utf8");
+const swaggerDocument = YAML.parse(swagger);
+app.use("/api/v1/docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
 
 app.use("/api/v1/jobs", authenticateUser, jobRouter);
 app.use("/api/v1/users", authenticateUser, userRouter);