swagger-autogen을 이용한 내 프로젝트에 swagger 자동 적용

김예지·2021년 8월 2일
3
post-custom-banner
  1. 패키지 설치
npm install swagger-ui-express
npm install swagger-autogen
  1. app.js 수정
const swaggerUi = require("swagger-ui-express");
const swaggerFile = require("./swagger-output");


app.use("/swagger", swaggerUi.serve, swaggerUi.setup(swaggerFile));
  1. swagger.js 파일을 root 디렉토리에 추가

endpointsFiles에 라우터의 js들을 모두 추가해준다.

const swaggerAutogen = require("swagger-autogen")();

const doc = {
  info: {
    title: "My API",
    description: "Description",
  },
  host: "localhost:3000",
  schemes: ["http"],
};

const outputFile = "./swagger-output.json";
const endpointsFiles = [
  "./app.js"
];

swaggerAutogen(outputFile, endpointsFiles, doc);
  1. 명령어 실행
node ./swagger.js
  1. 서버 시작 후 접속 (localhost:3000/swagger)

  2. 내용에 맞게 상세 정보 수정하기

  • autogen으로 들어가지 않는 부분들 (parameter type, tag 등)을 잘 수정해준다.

참고 : http://nodejs-style.selfhow.com/post/?id=4559

profile
새싹
post-custom-banner

0개의 댓글