22.12.23 TIL

문제점

swagger UI 적용 방법

시도했던 것

swagger 관련된 라이브러리를 설치하고 수동으로 문서화를 진행

해결한 방법

swagger-autogen을 이용하여 문서화를 자동으로 해주고 세부적인 것들만 정해줌

// app.js
const swaggerUi = require("swagger-ui-express");
const swaggerFile = require("./swagger-output");


app.use("/swagger", swaggerUi.serve, swaggerUi.setup(swaggerFile));

// swagger.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);

// 명령어 실행
node ./swagger.js

알게 된 것

개발자들은 노가다를 굉장히 싫어하기 때문에 노가다성 있는 것들은 무조건 오토로 되는 것들이 있다.