VisualStudioCode Rest Client

Rest API 개발을 하거나 이용할 API 테스트를 할 때 Postman과 같은 도구가 오래전부터 이용되었지만 최근엔 IDE마다 조금더 경량으로 이용할 수 있는 방법이 생겼습니다. 그 중 VisualStudioCode에서 Rest Client 확장을 소개합니다.

 

 

주요 기능

• HTTP 요청 실행
  • GET, POST, PUT, DELETE 등 다양한 HTTP 메서드 지원
  • .http 또는 .rest 파일에서 HTTP 요청을 작성하고 실행 가능
• 환경 변수 지원
  • {{baseUrl}} 같은 변수로 동적인 요청 작성이 가능해 유연성 제공
• 요청/응답 시각화
  • JSON, XML 등 응답 데이터를 보기 쉽게 포맷하여 출력
  • 상태 코드, 헤더, 응답 시간 등 상세 정보 제공
• 요청 기록
  • 이전에 보낸 요청을 기록하고 재사용할 수 있는 기능
• 복합 요청 처리
  • 파일 업로드와 같은 복잡한 요청도 간단히 실행 가능
• 인증 지원
  • Basic 인증, Bearer Token, OAuth 2.0 등의 인증 방식 지원

 

 

활용 샘플

@baseUrl = https://api.example.com
@serviceKey = AWERARPJGWAERTJAEOPRJAWER

# GET 요청
GET {{baseUrl}}/?ServiceKey={{serviceKey}}

###

# POST 요청
POST {{baseUrl}}/getStanReginCd
Content-Type: application/json

{
 "ServiceKey" : "AWERARPJGWAERTJAEOPRJAWER"
}

###

# PUT 요청
PUT {{baseUrl}}/users/123 HTTP/1.1
Content-Type: application/json

{
  "status": "inactive"
}

###

# FORM-DATA 요청
POST {{baseUrl}}/upload HTTP/1.1
Content-Type: application/x-www-form-urlencoded

userId=123&fileName=myfile.txt

###

# GET 요청 (헤더에 파라미터 추가)
GET {{baseUrl}}/protected-resource HTTP/1.1
Authorization: Bearer {{serviceKey}}
Content-Type: application/json

 

위와 같이 변수를 선언해서 API마다 반복되는 값들을 따로 관리할 수도 있고 하나의 .http 파일에서 여러가지 API를 사용할 수도 있습니다. .http 파일만 형상관리한다면 협업하는 동료들과도 문서 처럼 활용할 수 있습니다.

 

 

위 스크린샷 처럼 호출 할 URL을 선언하고 나면 API Method 위에 Send Request라는 텍스트가 클릭할 수 있게 활성화되고, 클릭하면 우측에 API 실행결과가 자세하게 표시됩니다.

먼저 말씀드렸듯이 다른 IDE에도 이와 비슷한 기능들이 있기에 개발할 때 사용하는 IDE 에서 Rest API를 테스트하는 통합된 워크플로우를 경험해보시길 추천드립니다.