[ 13 ] Swagger API-Docs 생성 실습

라이브러리 설치 

yarn add swagger-ui-express

yarn add swagger-jsdoc

 

app.js  ( entry page ) 페이지 설정 

import swaggerUi from 'swagger-ui-express'
import swaggerJSDoc from 'swagger-jsdoc'
import { options } from './swagger/config.js // swagger 설정 파일


const swaggerSpec = swaggerJSDoc(options)

// 두번째 함수는 next() 함수처럼 다음 미들웨어 함수이다
app.use('/api-docs',swaggerUi.serve,swaggerUi.setup(swaggerSpec))

options 설정 

export const options = {
    definition : {
        openapi : '3.0.0',
        info : {
            title : "Hello World",
            version : "1.0.0",
        },

    },
    apis : ['./swagger/*.swagger.js'],
};

 

예시 api 

/**
 * @swagger
 * /boards:
 *   get:
 *     summary: 게시글 가져오기
 *     tags: [Board]
 *     parameters:
 *       - in: query
 *         name: number
 *         type: int
 *     responses:
 *       200:
 *         description: 성공
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 properties:
 *                   number:
 *                     type: int
 *                     example: 1
 *                   writer:
 *                     type: string
 *                     example: 철수
 *                   title:
 *                     type: string
 *                     example: 좋은아침 입니다~
 *                   contents:
 *                     type: string
 *                     example: 오늘 하루도 파이팅 하세요!
 */


/**
 * @swagger
 * /boards:
 *   post:
 *     summary: 게시글 등록하기
 *     tags: [Board]
 *     responses:
 *       200:
 *         description: 성공
 */