강의 외적인 질문입니다.

Question

안녕하세요 선생님. 선생님의 강의를 듣고 사이드 프로젝트를 진행하고 있습니다. 그러던 중 API 명세와 관련되서 고민되는 점이 있어 조언을 얻고자 질문을 남깁니다. API 명세를 위한 tool을 찾아보던 중 swagger를 알게되었고 적용을 하려했으나 러닝커브가 있어 망설여지네요. 선생님께서는 API 명세를 작성할 때 어떤 방식으로 진행하시는지 궁금합니다! 감사합니다!

김시훈 (도도소프트) · Answer

Dev님 안녕하세요 :) REST API 개발할 때 swagger 많이 사용되고 좋은걸로 알고 있습니다. 전 아직 써보진 못했고 예전에는 Postman으로 관리했었어요, (아마 Postman보다는 swagger를 더 많이 사용할거에요) REST를 사용한지 꽤 오래 됬거든요 ㅎㅎ 의 만들면서 오랜만에 사용해봤네요 요즘은 백엔드를 GraphQL로 개발하고 있어요. GraphQL로 개발하게 되면 장점 중 하나가 API명세서를 따로 만들지 않아도 되요. API를 만들어주면 명세서를 자동으로 만들어주거든요. GraphQL API 경로를 브라우저로 접속하게 되면 아래 그림처럼 GraphQL API를 호출 할 수 있는 GUI가 뜨는데요. 오른쪽에 Docs라고 되어 있는 부분을 클릭하면 호출 가능한 API들을 모두 확인할 수 있어요. 실제로 호출할 수도 있고요. 그리고 주어진 규칙으로 API 사용 안내를 주석으로 남겨주면 자동 생성된 Docs에 모두 나옵니다 ㅎㅎ 다음으로 준비중인 강의가 그래프큐엘 시리즈입니다! 기대해주세요~