Merge pull request #103 from boostcampwm-2024/feature/be/setup

[BE][Docs] #82 : swagger 설치 및 예시 적용

backend/package.json

@@ -20,6 +20,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "express": "^4.21.1"
+    "express": "^4.21.1",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1"
   }
 }

backend/src/index.js

@@ -1,12 +1,17 @@
-const express = require('express');
+import express from 'express';
+import swaggerUi from 'swagger-ui-express';
+import specs from '../swaggerConfig.js';
 
 const app = express();
-const port = process.env.PORT || 3000;
+const port = 3001;
 
-app.get('/', (req, res) => {
-  res.json({
-    success: true,
-  });
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
+
+// 예제 라우터 (추가 예정인 라우터의 주석을 Swagger 주석 형식으로 문서화)
+app.get('/example', (req, res) => {
+  res.send('Hello World');
 });
 
-app.listen(port, () => {});
+app.listen(port, () => {
+  console.log(`Server is running on http://localhost:${port}`);
+});

backend/src/routes/example.js

@@ -0,0 +1,13 @@
+/**
+ * @swagger
+ * /example:
+ *   get:
+ *     summary: Example endpoint
+ *     description: Returns a simple "Hello World" message
+ *     responses:
+ *       200:
+ *         description: Successful response
+ */
+app.get('/example', (req, res) => {
+  res.send('Hello World');
+});

backend/swaggerConfig.js

@@ -0,0 +1,24 @@
+import swaggerJSDoc from 'swagger-jsdoc';
+
+const swaggerDefinition = {
+  openapi: '3.0.0',
+  info: {
+    title: 'Your API Name',
+    version: '1.0.0',
+    description: 'API documentation for Your Project',
+  },
+  servers: [
+    {
+      url: 'http://localhost:3001',
+    },
+  ],
+};
+
+const options = {
+  swaggerDefinition,
+  apis: ['./routes/*.js'],
+};
+
+const specs = swaggerJSDoc(options);
+
+export default specs;