[IntelliJ] REST API 테스트를 위해 사용하는 .http (feat. Postman 대체)

자바(Java)를 이용해서 서버프로그래밍을 하다 보니 결과가 눈에 보이지 않아서 테스트 프로그램도 만들고 Postman으로도 다시 API를 실행시켜서 정상적으로 동작하는지 확인하는 경우가 많다. 하지만 이보다 조금 더 편리한 방법이 있어서 소개하려 한다.

이번 포스팅에서는 REST API를 테스트하기 위해서 사용하는 .http 파일에 대해서 알아보자.

---

IntelliJ IDEA에서 '.http' 파일을 사용한 REST API 테스트

IntelliJ IDEA는 HTTP 클라이언트와 비슷한 기능을 가능 '.http' 파일을 지원한다. 이 파일을 사용하여 간단하게 REST API 요청을 작성하고 실행할 수 있다.

 

그럼 사용 방법부터 알아보자.

---

'.http' 파일 생성

가장 먼저 테스트 하고자 하는 프로젝트에서 파일을 만들어 주어야 한다.

test > resources > rest 라는 폴더를 만들고 여기에 'HTTP Request'라는 파일을 생성해 준다. 파일이름은 아무거나 상관없지만 확장자는 반드시 '.http'로 생성해 준다.

---

API 테스트

만든 파일에 GET 요청을 한 번 날려보자. 사용방법은 간단하다.

[API 종류] [요청할 주소]

API 메서드와 실제 요청할 주소를 작성하고 실행해주면 된다.

실행하면 요청에 대한 결과가 바로 IntelliJ 하단에 나타난다.

이처럼 너무 쉽게 API에 대한 테스트가 가능하다. 하지만 여기서 조금 더 편리한 방법을 사용하기 위해서 몇 가지 기능을 사용해 보자.

---

env.json 파일 사용하기

매번 긴 url를 입력해서 테스트할 수도 있지만 복/붙 하거나 작성해야 하는 어려움이 발생한다. 그래서 url주소와 같이 공통된 값을 alias 할 수 있는 기능이 있다.

 

먼저 동일한 위치에 'http-client.env.json'이라는 파일을 하나 생성한다.

이 파일의 내부에 json 구조로 아래와 같이 넣어보자.

{
  "local": {
    "url": "localhost:8080"
  }
}

이 경우 환경은 local 환경이라는 의미이며, 로컬환경을 선택했을 때 url이라는 값은 localhost:8080이라는 값으로 대체할 수 있게 된다. 그러면 다시 테스트를 해보자.

---

Header와 Body 사용하기

API를 사용하는 메서드는 GET 뿐만 아니라 Body를 가지고 있는 POST, PUT, PATCH가 있다. 이때는 아래와 같은 형태로 사용해 주면 된다.

[API명] [URL]
[Request Headers]

{
	... // JSON body
}

그럼 실제 예를 들어서 다시 보자.

위와 같이 Content-Type을 정해줄 수 있으며 내부에 Body도 만들어서 Request 할 수 있다.

---

이번 포스팅에서는 IntelliJ를 이용해서 '.http' 파일을 이용한 REST API 테스트에 대해서 알아보았다. 이 방법을 사용하고 나서부터 Postman을 켜서 다시 API를 만드는 번거로운 작업을 안 하게 된 것 같다. IntelliJ IDEA의 기능이 점점 더 막강해지면서 좋은 기능과 플러그인들이 많아져서 개발에 조금 더 집중하게 되는 것 같다.