📗 Swagger란?

우리가 만든 API를 문서화해줄 수 있는 오픈 소스 프레임워크(?)이다

이렇게 생겼고, 각 메소드마다 우리가 만든 API들을 여기서 호출할 수 있다 !
만들고 나서 스웨거만 쓰고 포스트맨은 거의 안쓴 것 같음..

📕 Fastify에서 swagger 사용하기

fastify에서 swagger를 사용하는 부분에 대해 구글링을 하면 자세히 또는 잘 안나온다...

• 본인의 경우 아래와 같이 모듈을 설치했다.

npm install @fastify/swagger @fastify/swagger-ui

• 이후 plugins 디렉터리 내부에 swagger.js를 생성해준다.

• swagger.js에서 다음과 같이 모듈들을 불러와준다 !

const fp = require('fastify-plugin');
const swagger = require('@fastify/swagger');
const swaggerUi = require('@fastify/swagger-ui');

• 이후 swagger 및 swagger-ui 생성

  

swagger

swagger 생성 시 title, description, version의 이해를 돕기 위한 이미지입니다

swagger-ui

routePrefix : swagger를 볼 수 있는 엔드포인트를 의미합니다 !
uiConfig : swagger의 사용자 인터페이스 구성 옵션를 설정하는 부분

swagger에 내가 만든 API 추가하기

위와 같이 설정을 했다면 swagger에 이미 내가 만든 API들이 자동으로 추가되어있지만,
그 API에 필요한 parameter값들은 설정이 안되있을 것이다...

그래서 api의 router부분의 엔드포인트 뒤에 JSON schema를 추가해주면 된다 !

📘 swagger 사용하며 느낀 점

• 만들고 난 후 포스트맨보다 훨씬 편함을 느꼈다.

• fastify의 경우, swagger를 사용하는 부분에 대해 자료가 많이 부족한 거 같다... 🥕

• 다른 개발자와의 소통이 훨씬 쉽다 !