[TIL] NestJS 공부 38일차

OpenAPI

OpenAPI란 RESTfulAPI를 설명하는데 사용 언어에 구애받지 않고 정의하는 형식입니다.
Swagger를 이용해서 API를 설명합시다.

설치

npm install --save @nestjs/swagger swagger-ui-express

만약 fastify를 사용한다면 아래의 명령어를 대신해주면 되지만 저는 fastify보단 전에 한번 써본 모듈로 해보겠습니다.

npm install --save @nestjs/swagger fastify-swagger

스웨거 사용

위 코드는 Swagger를 초기화시켜주는 기본 문구들입니다.
Swagger에서 기본인 Title, Description,Version,Tag를 지정해주고 build()를 넣은 후 createDocument()를 이용해서 만들어줍시다.
이 때, setup()안에 있는 api라는 글자는 swagger 페이지의 주소를 설정해주는 것이기 때문에 원한다면 바꾸셔도됩니다.

여기서 옵션을 추가한다면 완벽한 문서를 만들 수 있습니다.