Feat: User Server - Swagger Api-doc

user-server/package.json

@@ -29,6 +29,8 @@
     "@": "./src"
   },
   "devDependencies": {
-    "eslint": "^8.26.0"
+    "eslint": "^8.26.0",
+    "swagger-jsdoc": "^6.2.5",
+    "swagger-ui-express": "^4.6.0"
   }
 }

user-server/server.js

@@ -16,6 +16,6 @@ sequelize.authenticate()
   console.log(err);
 })
 
-app.listen(process.env.SERVER_PORT, ()=>{
+app.listen(process.env.SERVER_PORT, '0.0.0.0', ()=>{
   console.log("서버 시작");
 });

user-server/src/api/v1/index.js

@@ -8,7 +8,19 @@ const userRouter = require('./user/index');
 
 const router = Router();
 
-// API 진입점
+/**
+ * @swagger
+ *  /:
+ *    get:
+ *      tags:
+ *      - Index
+ *      description: 웰컴 페이지
+ *      produces:
+ *      - application/json
+ *      responses:
+ *       200:
+ *        description: 테스트 성공
+ */
 router.get('/', (req, res) => {
 	return res.send("<h1>Welcome to Api!</h1>");
 });

user-server/src/api/v1/login/index.js

@@ -8,6 +8,34 @@ const validators = require('@/middleware/validators');
 
 const router = Router();
 
+
+/**
+ * @swagger
+ *  /login:
+ *    post:
+ *      tags:
+ *      - authorization
+ *      description: API 서버에 로그인하여 JWT 토큰을 발급받습니다.
+ *      produces:
+ *      - application/json
+ *      parameters:
+ *      - in: body
+ *        name: body
+ *        required: true
+ *        schema:
+ *          properties:
+ *            id:
+ *              type: string
+ *              example: testtest
+ *            pw:
+ *              type: string
+ *              example: test123!
+ *      responses:
+ *       200:
+ *        description: 로그인 성공
+ *       400:
+ *        description: 로그인 실패
+ */
 router.post('/', ...validators.login, async (req, res) => {
   passport.authenticate('local', (error, user, info) => {
     if (error || !user) {

user-server/src/api/v1/logout/index.js

@@ -4,6 +4,19 @@ const { Router } = require('express');
 
 const router = Router();
 
+/**
+ * @swagger
+ *  /logout:
+ *    post:
+ *      tags:
+ *      - authorization
+ *      description: API 서버에서 로그아웃하여 JWT 토큰을 제거합니다.
+ *      produces:
+ *      - application/json
+ *      responses:
+ *       200:
+ *        description: 로그아웃 성공
+ */
 router.get('/', async (req, res) => {
   req.logout();
   req.session.destroy();

user-server/src/api/v1/signup/index.js

@@ -7,6 +7,39 @@ const validators = require('@/middleware/validators');
 
 const router = Router();
 
+/**
+ * @swagger
+ *  /signup:
+ *    post:
+ *      tags:
+ *      - authorization
+ *      description: 회원가입합니다.
+ *      produces:
+ *      - application/json
+ *      parameters:
+ *      - in: body
+ *        name: body
+ *        required: true
+ *        schema:
+ *          properties:
+ *            id:
+ *              type: string
+ *              example: testtest
+ *            email:
+ *              type: email
+ *              example: [email protected]
+ *            username:
+ *              type: string
+ *              example: Test
+ *            pw:
+ *              type: string
+ *              example: test123!
+ *      responses:
+ *       200:
+ *        description: 회원가입 성공
+ *       400:
+ *        description: 회원가입 실패
+ */
 router.post('/', ...validators.signup, async (req, res) => {
   let result = UserService.signup({
     id: req.body.id,

user-server/src/api/v1/user/id/index.js

@@ -7,7 +7,33 @@ const validators = require('@/middleware/validators');
 
 const router = Router();
 
-// ID 찾기
+/**
+ * @swagger
+ *  /user/id:
+ *    post:
+ *      tags:
+ *      - authorization
+ *      description: Email과 Username으로 ID를 찾습니다.
+ *      produces:
+ *      - application/json
+ *      parameters:
+ *      - in: body
+ *        name: body
+ *        required: true
+ *        schema:
+ *          properties:
+ *            email:
+ *              type: email
+ *              example: [email protected]
+ *            username:
+ *              type: string
+ *              example: Test
+ *      responses:
+ *       200:
+ *        description: ID 찾기 성공
+ *       400:
+ *        description: ID 찾기 실패
+ */
 router.get('/', ...validators.findId, async (req, res) => {
   let email = req.body.email;
   let user = req.body.user;

user-server/src/api/v1/user/pwd/index.js

@@ -7,7 +7,34 @@ const validators = require('@/middleware/validators');
 
 const router = Router();
 
-// PW 변경
+/**
+ * @swagger
+ *  /user/pwd:
+ *    post:
+ *      tags:
+ *      - authorization
+ *      description: 유저 비밀번호를 변경합니다. (WIP)
+ *      produces:
+ *      - application/json
+ *      parameters:
+ *      - in: body
+ *        name: body
+ *        description: pw는 변경할 Password입니다.
+ *        required: true
+ *        schema:
+ *          properties:
+ *            id:
+ *              type: email
+ *              example: testtest
+ *            pw:
+ *              type: string
+ *              example: qwer123!
+ *      responses:
+ *       200:
+ *        description: PW 변경 성공
+ *       400:
+ *        description: PW 변경 실패
+ */
 router.post('/', ...validators.changePassword, async (req, res) => {
   let id = req.body.id;
   let pw = req.body.password;

user-server/src/app.js

@@ -6,6 +6,7 @@ const session = require("express-session");
 
 const routers = require('@/api/v1/index');
 const passport = require('@/middleware/passport');
+const {swaggerUi, specs} = require('@/middleware/swagger');
 
 const app = express();
 
@@ -28,6 +29,8 @@ app.use((req, res, next)=>{
   next();
 })
 
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
+
 app.use(routers);
 
 module.exports = app;

user-server/src/middleware/swagger.js

@@ -0,0 +1,24 @@
+'use strict';
+
+const swaggerUi = require('swagger-ui-express');
+const swaggerJsdoc = require('swagger-jsdoc');
+
+const options = {
+    swaggerDefinition: {
+        info: {
+            title: 'AllWrite User-server API',
+            version: '1.0.0',
+            description: 'Test API with express',
+        },
+        host: 'localhost:3000',
+        basePath: '/api/v1'
+    },
+    apis: ['./src/api/v1/**/*.js']
+};
+
+const specs = swaggerJsdoc(options);
+
+module.exports = {
+    swaggerUi,
+    specs
+};