24/09/04 - Node.js 입문(1 - 8): API Client

API Client는 개발단계에서 작성된 API 요청을 확인하거나 테스팅 할 때 도움을 주는 툴이다.

이를 사용함으로 개발 속도를 높이거나 잘못된 API 요청으로 인한 치명적인 에러를 예방하는데 도움을 받을 수 있다.

 

대표적인 API Client로는 Postman, Insomnia가 있다. 이 둘은 API 요청을 손쉽게 구성할 수 있고, 응답을 직관적으로 확인할 수 있게 도와준다. 특히 Insomnia은 사용자 친화적인 UI와 간편하게 API 테스팅을 할 수 있는 기능을 제공하고 있다.

 

 

 

이전 시간에 API를 배워 실습을 했을 때, HTTP Method 중 GET에 대응하는 API를 구현하고, 웹 브라우저를 통해 확인했다.(https://dkskfktldi.tistory.com/entry/240903-Nodejs-%EC%9E%85%EB%AC%B81-7-Routing)

 

하지만 그 외에도 POST, PATCH, PUT, DELETE 등의 HTTP Method가 필요하다. 그러나 웹 브라우저에선 GET만 바로 확인할 수 있기 때문에 여러가지의 테스트들이 실행되지 않는 문제가 발생한다.

따라서 이런 문제를 해결하기 위해 좀 더 쉽고 친숙하게 사용할 수 있는 API Client를 사용할 것이다.

 

 

 

Insomnia API Client 설치

• 설치를 위해 해당 사이트에 들어간다.(https://insomnia.rest/)
• 그 후 `Get Started for Free` 를 클릭한다.

 

• Free 존을 선택하고, 다운 받는다.
• 다운 받은 걸 실행하면 아래 이미지처럼 동작한다.

 

• 이후 Continue를 눌러 계정과 연동하면 아래와 같은 창이 된다.

 

• 새로운 파일을 만든다.

+ 클릭으로 만들 수 있다.

My project 생성

 

• 실제로 API를 생성하고 테스트하기 위해 중간에 있는 Create을 클릭 → Request collection 클릭

 

• 테스트 하려는 프로젝트의 이름을 작성한다. 나는 week4라고 입력했다.
  여기서 Collection은 테스트하려는 프로젝트의 단위이다.

생성 완료

 

• 실행을 위해 만들어둔 week4를 클릭
• 아래 +를 클릭 → HTTP Request 클릭하여 테스트하려는 Request를 생성한다.

 

• 어떤 API인지 나타내기 위해 api/about 라고 이름을 변경한다.

 

• 어떤 주소로 요청할 건지 알기 위해 GET 부분에 ` localhost:3000/api/about` 를 입력한다.
  

 

• 해당 부분은 GET 메서드를 통해 요청을 보낸다고 정의되기 때문에, 오른쪽에 있는 Send를 클릭하면 정상적으로 API가 요청된다.
  이를 확인하기 위해 다시 node.js로 들어가 서버를 열어 테스트한다.
  확인해보면 다음과 같이 뜬다.

 

 

 

Insomnia 활용

• Collections
  특별한 프로젝트마다 API 목록을 정리해서 사용할 수 있다.
  여러가지의 API의 요청(Request)을 그룹화 시킬 수 있다.
  
  
• Environment
  여러번 사용되는 값들을 환경변수(Environment)로 설정할 때 사용한다.
  Token, URL, 개인 키 등 다양한 자격증명을 저장 및 사용할 수 있다.