Applying Swagger - Open-source code tool.

package.json

@@ -44,6 +44,8 @@
     "@fastify/jwt": "^8.0.0",
     "@fastify/multipart": "^8.1.0",
     "@fastify/static": "^6.12.0",
+    "@fastify/swagger": "^8.14.0",
+    "@fastify/swagger-ui": "^2.1.0",
     "@prisma/client": "5.8.1",
     "@types/bcryptjs": "^2.4.6",
     "@types/express": "^4.17.21",

src/app.ts

@@ -1,4 +1,3 @@
-import fastify from 'fastify'
 import { userRoutes } from './controller/user/routes'
 import { env } from './env'
 import { ZodError } from 'zod'
@@ -8,8 +7,14 @@ import cors from '@fastify/cors'
 import { logMiddleware } from './controller/middlewares/logMiddleware'
 
 import { projectRoutes } from './controller/project/routes'
+import fastify from 'fastify'
+
+import { setupSwagger } from './swagger'
 
 export const app = fastify()
+
+setupSwagger(app)
+
 app.register(cors, {
   origin: [env.FRONTEND_URL],
 })

src/controller/project/routes.ts

@@ -9,6 +9,9 @@ import fastifyStatic from '@fastify/static'
 import { getProjectsByTags } from './getProjectsByTags'
 import { editProject } from './editProjectById'
 import { deleteProjectById } from './deleteProjectById'
+import getProjectByUserIdSchema from './swagger/getProjectsByUserIdSwagger.json'
+import getProjectByIdSchema from './swagger/getProjectByIDSwagger.json'
+import createProjectSwagger from './swagger/createProjectSwagger.json'
 
 export async function projectRoutes(app: FastifyInstance) {
   app.register(FastifyMultipart, {
@@ -24,11 +27,11 @@ export async function projectRoutes(app: FastifyInstance) {
   })
 
   app.post('/projects/tags', getProjectsByTags)
-  app.get('/projects/:userId', getProjectsByUserId)
-  app.get('/project/:projectId', getProjectsById)
+  app.get('/projects/:userId', getProjectByUserIdSchema, getProjectsByUserId)
+  app.get('/project/:projectId', getProjectByIdSchema, getProjectsById)
 
   app.post('/project/:projectId/photo', addImageProject)
-  app.post('/user/:userId/project', createProject)
+  app.post('/user/:userId/project', createProjectSwagger, createProject)
 
   app.put('/project/:projectId/edit', editProject)
   app.delete('/project/:projectId', deleteProjectById)

src/controller/project/swagger/createProjectSwagger.json

@@ -0,0 +1,70 @@
+{
+  "schema": {
+    "tags": [
+      "Project"
+    ],
+    "summary": "Create Project",
+    "description": "Create a project based on the user ID.",
+    "operationId": "createProject",
+    "body": {
+      "title": "object",
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "link": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "title",
+        "tags",
+        "link",
+        "description"
+      ],
+      "type": "object"
+    },
+    "params": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string",
+          "format": "uuid"
+        }
+      },
+      "required": [
+        "userId"
+      ],
+      "type": "object"
+    },
+    "response": {
+      "201": {
+        "description": "Project created successfully",
+        "type": "object",
+        "properties": {
+          "project": {
+            "type": "object"
+          }
+        }
+      },
+      "409": {
+        "description": "User was not Found !",
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

src/controller/project/swagger/getProjectByIDSwagger.json

@@ -0,0 +1,47 @@
+{
+  "schema": {
+    "tags": [
+      "Project"
+    ],
+    "summary": "Get project by ID",
+    "description": "Retrieves project information based on the provided project ID.",
+    "operationId": "getProjectById",
+    "parameters": [
+      {
+        "name": "projectId",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "description": "The ID of the project to retrieve."
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "Project found and returned successfully.",
+        "content": {
+          "application/json": {
+            "example": {
+              "project": {
+                "id": "example_uuid",
+                "name": "Example Project"
+              }
+            }
+          }
+        }
+      },
+      "404": {
+        "description": "Project not found.",
+        "content": {
+          "application/json": {
+            "example": {
+              "error": "Project not found."
+            }
+          }
+        }
+      }
+    }
+  }
+}

src/controller/project/swagger/getProjectsByUserIdSwagger.json

@@ -0,0 +1,51 @@
+{
+  "schema": {
+    "tags": [
+      "Project"
+    ],
+    "summary": "Get projects by user ID",
+    "operationId": "getProjectsByUserId",
+    "parameters": [
+      {
+        "name": "userId",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "description": "The ID of the user to retrieve projects for."
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "Projects found and returned successfully.",
+        "content": {
+          "application/json": {
+            "example": {
+              "projects": [
+                {
+                  "id": "example_uuid_1",
+                  "name": "Project 1"
+                },
+                {
+                  "id": "example_uuid_2",
+                  "name": "Project 2"
+                }
+              ]
+            }
+          }
+        }
+      },
+      "404": {
+        "description": "User not Found !",
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

src/controller/user/Swagger/getUserByIdSchema.json

@@ -0,0 +1,42 @@
+{
+  "schema": {
+    "tags": [
+      "User"
+    ],
+    "summary": "Get user by ID",
+    "description": "Retrieves user information based on the provided user ID.",
+    "operationId": "getUserById",
+    "parameters": [
+      {
+        "name": "id",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "description": "The ID of the user to retrieve."
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "User found and returned successfully.",
+        "type": "object",
+        "properties": {
+          "message": {
+            "description": "User found and returned successfully"
+          }
+        }
+      },
+      "404": {
+        "description": "User not found.",
+        "type": "object",
+        "properties": {
+          "message": {
+            "description": "User not found."
+          }
+        }
+      }
+    }
+  }
+}

src/controller/user/Swagger/registerUserSchema.json

@@ -0,0 +1,55 @@
+{
+  "schema": {
+    "tags": [
+      "User"
+    ],
+    "summary": "Register a new user",
+    "description": "Registers a new user with the provided information.",
+    "operationId": "registerUser",
+    "body": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "surname": {
+          "type": "string"
+        },
+        "email": {
+          "type": "string",
+          "format": "email"
+        },
+        "password": {
+          "type": "string",
+          "minLength": 6
+        }
+      },
+      "required": [
+        "name",
+        "surname",
+        "email",
+        "password"
+      ]
+    },
+    "response": {
+      "201": {
+        "description": "User successfully registered",
+        "type": "object",
+        "properties": {
+          "message": {
+            "description": "No body returned for response"
+          }
+        }
+      },
+      "409": {
+        "description": "E-mail already exists.",
+        "type": "object",
+        "properties": {
+          "message": {
+            "description": "E-mail already exists."
+          }
+        }
+      }
+    }
+  }
+}