[Node.js] Swagger 세팅하는 법

REST API를 설계, 빌드, 문서화 등 사용하는데에 도움이 되는 swagger 세팅하는 법을 간단하게 알아보자

1. 먼저 라이브러리 설치하기

npm i swagger-jsdoc swagger-ui-express swagger-cli --save-dev

2. swagger 설정파일 생성하기 (나는 swagger폴더를 생성해서 안에 설정 파일을 만들어줬다. 그리고 아래 코드는 기본적인 세팅만 있고 추가적인 세팅은 다음에 자세히 다뤄보자)

#swagger/swagger.config.js파일

import SwaggerJsdoc from "swagger-jsdoc";

const options = {
    definition: {
        info: {
            title: '제목 설정',
            version: '1.0.0',
            description: 'API 설명'
        },
        host: 'localhost:3000',
        basepath: '../'
    },
    apis: ['./src/routes/*.js', './swagger/*']
};

export const specs = SwaggerJsdoc(options);

3. 설정 경로에 swagger 화면이 나올수 있게 설정 (나는 /api-docs로 설정!)

import { specs } from './swagger/swagger.config.js';
import SwaggerUi from 'swagger-ui-express';

app.use(express.urlencoded({extended: false})); 

// swagger
app.use('/api-docs', SwaggerUi.serve, SwaggerUi.setup(specs));

// 기타 router setting
(...)

4. npm run start를 하고 localhost:3000/api-docs로 들어가면 swagger 화면이 나온다~