Swagger를 이용하여, API를 문서화하는 작업을 학습하며, 게시판 기능 고도화 챕터를 모두 마무리할 수 있었다. API 문서화는 실제로 프로젝트를 진행하는 단계에서도 중요하고, 나아가, 오픈한 서비스를 운영하는 단계에서도 아주 중요한 요소라는 생각이 든다. 이전에 IT 교육을 받는 과정에서, 나는 프론트엔드 개발을 맡고, 팀원은 백엔드 개발을 맡아 협업을 한 경우가 있었는데, 당시 팀원인 백엔드 개발자가 API 정보를 보기 쉽게 안내해주는 방법으로, Swagger UI로 구현된 페이지를 공유해 적이 있었다. 당시에 나는 Java, Spring을 이용한 백엔드 기술에 대한 지식이 전무했기 때문에, 어떻게 저렇게 깔끔한 UI로 보기 쉽게 API 정보를 정리할 수 있지 라는 생각을 하였는데, 오늘 강의를 학습하면서, 별도의 모듈로서 제공되는 기능이라는 점을 제대로 알게 되었다. 추후에 사이드 프로젝트를 진행하거나, 다른 협업을 하게 된다면 해당 기능을 적극적으로 사용해봐야겠다는 생각이 들었다. 프로젝트 개발 뿐만 아니라, 시스템을 운영하는 입장에서도 이러한 API 정보를 문서화하는 것이 상당히 중요한데, 데이터의 오류, 누락, 장애가 발생했을 경우, 프론트엔드에서 요청하는 정보가 어떤 컨트롤러를 통해 응답되는지를 파악하기 위해서는 API에 해당하는 호출 URL과 파라미터 등이 필수적이기 떄문이다. 아쉽게도 현재 운영하고 있는 시스템은 오픈한지 오래된 버전이기도 하고, REST API 방식으로 데이터를 받는 형태가 아니기 때문에, 이러한 API 문서는 없지만, 추후에 REST API 방식으로 변경하게 된다면, 실무에서 많이 사용하고 있는 Swagger를 이용한 문서화 작업을 진행하는 것이 필수적이라는 생각이 든다. 이러한 Swagger를 통한 문서화 작업 시, Java Docs 모듈을 추가로 이용하여 각각에 한글이나 영문으로 된 API 정보를 추가해줄 수 있는데, 이러한 방식으로 유지보수하기 좋은 코드, 협업하기 좋은 코드를 구축한다면, 업무를 효율적으로 처리할 수 있을 것이다.
패스트캠퍼스 [직장인 실무교육]
프로그래밍, 영상편집, UX/UI, 마케팅, 데이터 분석, 엑셀강의, The RED, 국비지원, 기업교육, 서비스 제공.
fastcampus.co.kr
본 포스팅은 패스트캠퍼스 환급 챌린지 참여를 위해 작성하였습니다.