[NestJS] NestJS에서 API문서 자동화 도구 Swagger 사용하기


[NestJS] NestJS에서 API문서 자동화 도구 Swagger 사용하기

Swagger는 API문서 자동화 도구이다. 따로 API문서를 작성하는것이 아닌 그냥 코드를 작성하면서 API문서를 수정할 수 있다. 그렇게 수정된 코드는 자동으로 API문서를 만들어준다. 이제 사용방법에 대해 알아보자. 우선 아래와 같이 모듈들을 설치해주자. 여기서 만약 NestJS(express)가 아닌 NestJS(fastify)를 쓸 경우 swagger-ui-express대신 fastify-swagger를 설치해주자. 이후 이 swagger를 미리 main.ts에 연결해주자. 아래 코드를 추가해주자. 이후 main.ts의 코드는 아래와 같다. 이후 user 컨트롤러, 서비스 모듈정도만 있다고 해보자. 이후 서버를 아래와 같이 킨 뒤 localhost:3000/api로 가보면 아래와 같은 api문서 양식이 생긴 것..........



원문링크 : [NestJS] NestJS에서 API문서 자동화 도구 Swagger 사용하기