[221206] TIL

sequelize

• DB 조회 시, 조건을 주고 싶을 때에는 where

DB.findAll({where : {필드: 조건, 필드}});
// 조건과 필드명이 같은 경우 한 번만 적어도 됨

• 특정 필드에 대한 설정은 attribute

DB.findAll({attributes: { exclude: ['필드명']});
// exclude : 제외할 속성

Swagger

하나하나 주석을 넣어주기 귀찮아 찾아본 Swagger autogen 사용법

패키지 설치

npm install swagger-ui-express
npm install swagger-autogen

swagger.js

root 디렉토리에 하단 내용으로 생성

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"
  //여기에 라우터.js를 전부 적어준다.
];

swaggerAutogen(outputFile, endpointsFiles, doc);

app.js

하단 코드를 app.js에 추가시킨다.

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

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

아직 서버가 안 돌아가고, 빨간 줄이 그어지는 것이 맞는 상태!
생성한 swagger.js로 아직 swagger 관련 파일들을 생성하지 않았기 때문이다.

autogen !!

드디어 오토젠이다.
명령어 입력!

node ./swagger.js

이 명령어 수행 후, '주소/swagger'로 들어가면 정상적으로 보인다.

swagger-output.json

이 파일에서 descriptoin, response 등을 수정해주면 된다.