2022-06-15 swagger API 적용 후기

정종훈·2022년 6월 15일
0

T.I.L

목록 보기
20/20

왜 API를 바꿨는가

프로젝트에서 기존 gitbook으로 작성한 API는 API 확인을 위해 사이트에 들어가서 확인해야 하는 불편함때문에 대체 방안을 고민하게 되었고

swagger API는 서버를 틀어 특정 엔드포인트에 들어가면 API를 바로 볼 수 있다는 정보 떄문에 바꾸게 되었다

후기

API를 새로 만드는게 아니라 이미 구성되어있는 서버내용과 기존에 있던 API를 참고하여

다시 리팩토링? 하는거라 조금 버거웠었던것 같다.

특히 이걸 한다고 해서 내 실력이 뭐가 달라질까 라는 의문과

실제로 시간을 많이 투자해도 API 한 줄 달랑 추가되는 부분

그리고 그 한 줄이 추가 되기 위해 만난 엄청난 에러와 나의 무지함에 정말 쉽지 않은 작업이었다.

그래도 이 작업을 하는도중

  • 컴포넌트 분리의 중요성

  • API의 자동화 개념

이 두개를 스스로 깨닫게 되었다.

우선 컴포넌트 분리를 통해 모듈화를 시켜 쉽게 말해 복붙만 하면 수많은 코드를 다시 치지 않아도 되고 특히 swagger에도 그런 기능이 있는 줄 처음알았다.

또한 API문서에서 실험?을 통해 실제 서버 응답으로 어떻게 오는지를 실시간으로 확인할수 있다는 장점이 있었다. => 그러고 보니 나중에 다시 배포를 하게되면 swagger에 적용된 서버 주소도 다시 올려야 겠지?

마지막으로

처음에는 정말 별거아니라고 생각했던 작업도

정말 많은 일들이 필요하고

또 해냈다는 성취감을 프로젝트 이후 오랜만에 느껴보았다.

취직중이고 서류에 하나도 통과하지 못해 지금 어려운 시기에

이런 기쁨이 찾아와 오늘 힘을내서 오랜만에 블로그를 작성하게 되었다.

힘내자!!

profile
괴발개발자에서 개발자로 향해보자

0개의 댓글