Swagger
-
swagger란 공식문서에 다음과 같이 정의되어 있습니다REST API를 설계, 빌드, 문서화 및 사용하는 데 도움이되는 OpenAPI 사양을 중심으로 구축 된 오픈 소스 도구 세트입니다. -
간단히 말하자면 API 문서 자동화 도구이며, API를 테스트할 수 있는 화면을 제공합니다
-
nestJs는 express와 달리 코드를 수정하면서 API 문서를 간편하게 수정할 수 있다는 큰 장점이 있습니다
Swagger 설치
공식문서에 적힌 다음 명령어로 swagger를 설치하겠습니다
npm install --save @nestjs/swagger swagger-ui-express
만약 express대신 fastify를 사용하는 경우, swagger-ui-express 대신 fastify-swagger를 설치해야 합니다.
npm install --save @nestjs/swagger fastify-swagger
설치 프로세스가 완료되면 main.ts 파일을 열고 다음 이미지와 같이 SwaggerModule 클래스를 사용하여 Swagger를 초기화합니다.
이후 npm run start:dev로 재시작 후, http://localhost:3000/api/ 로 접속하면 다음과 같은 화면을 확인하실 수 있습니다.
그리고 nestJs의 swagger 지원 공식문서(https://docs.nestjs.com/openapi/introduction), 여러 글을 참조하며 아래 이미지같이 컬럼의 설명을 코드와 같이 추가하면, 협업에 도움을 주며 나중에 api를 다시 볼 때 구조도 더 빨리 파악하여 본인과 팀원간 개발 만족도가 올라갈 것입니다 :)
Reference
