1-12 API Client 학습

API Client 학습

 

1. API Client란?

 

API Client란 개발단계에서 우리가 작성한 API의 요청을 확인하거나 테스팅 할 때 도움을 주는 툴 입니다.

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

 

대표적인 API Client로 Postman, Insomnia가 있습니다.

 

API Client는 API 요청(Request)을 손쉽게 구성할 수 있고, 응답(Response)을 직관적으로 확인할 수 있게 도와줍니다.

 

 

2. 어떤 상황에 필요할까?

 

우리는 주로 데이터를 가져오는 데 사용되는 Http Method 중 GET에 대응하는

API를 구현하고, 웹 브라우저를 통해 확인해왔다.

 

그러나, 생성(POST), 수정(PUT, PATCH), 삭제(DELETE) 와 같은 작업이 필요할 경우

Http Method를 사용하는 APU를 개발하고 테스트 해야할 것이다.

 

이러한 사황에서 Termianl에 명령어를 입력하거나,

Html 파일을 생성하여, 각각의 APU를 테스트 할 수는 있지만,

더욱 편리하게 서버에 보낼 데이터와 주소를 한번에 관리할 수 있는

API Client를 사용해 볼 예정이다.

 

 

3. Insomnia API Client 설치 및 실행

 

1. Insomnia 공식 사이트 (다운로드 링크)를 설치 후 로그인 한다.

 

2. PROJECT 생성

+을 눌러 Project를 만든다.

프로젝트의 이름을 지정한다.

Project 생성 완료 후

Create 버튼을 눌러 파일을 생성한다.

Request Collection을 선택합니다.

컬렉션의 이름을 결정하고 Create 버튼을 누릅니다.

+ 버튼을 누르고, HTTP Request를 눌러줍니다.

HTTP Request 클릭

New Requst가 생긴걸 볼 수 있고 이름을 변경해줍니다.

 

현재 우리가 테스트 할 API는 /api 또는 /api/about

이기 때문에 파일 이름을 /api 또는 /api/about

으로 작성하는 것이 좋습니다.

 

 

위의 주소창에 우리가 테스트할 주소를 입력하고 Send 버튼을 클릭합니다.

이때, 서버는 열려 있어야 정상 동작 합니다.

/api/about의 결과가 잘 출력된 걸 볼 수 있고, 200 OK라고 정상 연결된 것 또한 볼 수 있다.

Headers를 통해 서버에서 어떠한 Headers 에서 확인할 수 있습니다.

 

 

4. 활용하기

 

1. Collections

향후 실무나 학습에서 각각의 프로젝트에 대한 Test가 생길거라

하나의 프로젝트를 Collection으로 만들어 하나의 프로젝트에

대한 실험을 진행한다.

 

2. API Test 대상을 URL로 나누어 작성

 

 

API Test 대상을 URL로 나눠 작성해 관리를 쉽게 한다.

 

3. Environment

 

여러 번 사용되는 값들을 환경변수(Eviroment)로 설정할 때 사용한다.

ex) Token, URL, 개인 키 등 다용한 자격증명을 저장 및 사용할 수 있습니다.