semtax의 개발 일지

개요 이번 포스팅에서는, Swagger를 이용해서 REST API 문서를 자동으로 생성하는 법을 다루려고 한다. ​ ​ ​ ​ 문서화의 중요성 한가지 상황을 가정해보도록 하자. ​ ​ 만약 여러분이 프론트 개발자, 다른 팀에서 만들어진 REST API를 사용 해야하는 입장의 개발자라고 가정을 해보자. 이때, 프로젝트가 다 됬다고 듣고, API를 사용하려고 봤는데 어떻게 사용하는지에 대한 메뉴얼을 주지 않아서 사용방법을 알아내기 위해 저 API를 개발한 직원을 직접 부르거나 여러분이 직접 저 코드들을 분석해서 사용방법을 알아내느라 1~2주가 소요 되어버렸다. 상상만 해도 정말 끔찍하다. 이런 상황을 어떻게 극복하면 좋을까? ​ ​ ​ ​ 위와 같은 상황을 방지해주기 위해, 저러한 API를 만들고 나서는 A..

개요 이번 포스팅 에는 Postman을 이용해서 자신이 만든 웹 서비스를 테스트 해보는 방법을 다뤄보도록 하겠다. 실습해볼 환경은 MAC OS X 기준으로 작성되었음을 알립니다. 설치 먼저 아래 링크로 접속을 해서 Postman을 다운로드 받어서 설치를 합니다. https://www.getpostman.com/downloads/ 설치가 완료되고나서 Postman을 실행하면 아래와 같은 화면이 나옵니다. 사용방법 보통 아래 그림과 같이 사용을 합니다. 위에서 보이는 그림과 같이 URL옆의 버튼으로 HTTP METHOD를 설정하고 URL을 적어준 뒤, Header탭에 보내려는 요청에 맞는 헤더들을 집어넣어주고 body 탭에 보낼 데이터를 넣어주면 된다. 그 외에도 포스트맨(Postman)같은 경우 Swagg..