[API] REST API 테스트,관리하기(REST Client Tool)

REST API가 적용 된 프로젝트 내에서 바로바로 확인을 할 수 없는 환경이 있을 경우 REST API 기능 테스트를 할 경우 해당 툴을 사용하시면 유용 할 것 같습니다.

우선적으로 REST API 가 무엇인지? REST가 무엇인지 궁금하신 분들은

http://meetup.toast.com/posts/92  <-- 이 곳을 참고해주세요.

1. 먼저 크롬에서 Advanced REST client를 설치 해주세요.

2. 설치 후 실행해주세요. 실행 초기 화면입니다.

왼쪽 네비를 보시면 HTTP request, Socket, History, Saved, Project 메뉴가 있습니다.

알려드릴 기능은

1) HTTP request  : 서버에 요청할 request를 작성하는 곳입니다.( method 방식, URL, Headers, Body 을 정의합니다.)

2) History   : 요청을 보낸 히스토리가 저장됩니다.

3) Saved   : 1번에서 만든 요청을 저장하면 Saved 목록에 저장이 됩니다.

3. HTTP request  작성(method 방식, URL, Headers, Body 작성)

제가 예시로 만든 api는 회원 프로필을 조회하는 api입니다.

- project 마다 header 부분이 다를 수 있습니다.

잘 확인해서 작성해주세요.

지금 프로젝트 같은 경우는 회원마다 로그인 했을때 유니크한 토큰을 이용해서 실제 로그인한 상태인지 아닌지를 확인하는 로직이 있어서 반드시 헤더에 apiToken이 반드시 필요한 경우 입니다.

- body에 필요한 json 데이터를 넣어주세요.

그 후 send 버튼을 클릭합니다.

4. 요청부터 응답까지 흐름입니다.

5. return 데이터가 화면에 찍는 것을 볼 수 있습니다.

 - 내가 만든 api가 요청에 정확한 응답을 주는지 확인 할 수 있습니다.

6. 작성한 Http Requset를 저장하는 방법을 설명 드리겠습니다.

- 먼저 1번 클릭 후 2번 SAVE 버튼을 클릭합니다.

- 3번에서 API에 대한 제목과 설명을 작성후 저장합니다.

7. 저장된 Test api는 saved 목록에 추가 됩니다.

지금 저는 로컬_00와 배포_00로 제목을 배포와 로컬로 구분해서 http request를 관리하고 있습니다.

제목만 보고도 어떤 APi와 맴핑 되는지 알 수 있게 되고,  바로바로 확인하고 테스트 할 수 있어서 빠른 테스트와 언제든지 다시 사용할 수 있기 때문에 저장해서 쓰시면 굉장히 편리하실 꺼라고 생각합니다.

8. 마지막으로 export data AND import data 입니다.

- 내가 저장한 api 목록을 export 할수 있고, 다른 사람이 export data를 import 할 수 있기 때문에 협업하는 개발자들의

http request를 취합할수 있습니다.

 

 

1. import and export data 를 클릭해주세요.

2. export 할 경우

  - 첫번째 항목(Saved requests and project)만 체크주시고, PREPARE DATA를 클릭해주세요.

  - 파일명을 작성해주시고 , 20171127_API_최승원.json 파일로 export 됩니다.

3. import 할 경우

 - OPEN FROM FILE를 클릭해주세요.

 - export한 json 파일을 선택해주시고, 저장해주시면 import가 됩니다.