TIL 77 (개인프로젝트 Swagger 진행상황)

앞 서 TIL 73에서 Swagger에 대해서 간단하게 알아봤었습니다. 이후에 학습하면서 남은 부분 구현을 진행했는데, 아직은 부족하긴 하지만 큰 틀을 완성해서 과정을 기록해보려고 합니다.

 

현재 진행 중인 개인 프로젝트가 로그인 후 AccessToken을 응답결과로 넘겨주고, 이 값을 Authorization 헤더에 넣어 인증을 하는 과정을 거치고 있습니다. 근데 Swagger에서 Authrization 헤더를 추가하는 데에 문제가 발생했습니다. 일단은 그 부분은 제외하고 파라미터나 쿼리, 요청 바디, 응답 결과에 대해서는 각 API 별로 완성을 했습니다.

 

위의 사진은 localhost:4000/api-docs에 접속했을 때 확인할 수 있는 API Document입니다. 

아래는 Swagger에서 쿼리와 파라미터 값을 넣어주는 방법으로 parameters 내부에 - in 을 통해서 각 각을 구분하고, API Document에서 값을 넣어서 테스트 해볼 수 있도록 입력하는 데이터의 타입과 설명을 추가해줬습니다.

 

지금까지 Swagger를 사용하면서 느꼈던 점은 Authorization 헤더를 추가하는 문제만 제외하면 POSTMAN으로 API Document를 작성하는 것보다 훨씬 쉽다는 점입니다. 이렇게 좋은 걸 이제서야 알고 사용해봤다는 것에 안타까움을 느끼고 있습니다. 개발자로써 현재보다 더 쉽게 서비스를 개발하고 문서화 작업을 하는 방법을 항상 고민하고 찾아봐야겠다는 것을 느꼈습니다.

 

오늘 이후로는 메뉴 데이터를 만들고, 소셜 로그인과 카카오 맵을 구현할 예정입니다. Authorization 헤더 문제는 해결되는 대로 공유하겠습니다.