VSCode RestClient 사용법

사내에서 백엔드 테스트를 위해 Postman을 자주 애용하는데, 필드의 경우 Private 망에서 운영된다. Public 망이 없는 환경에서 Postman 사용이 불가해서 대체품을 찾는 도중에 VSCode의 RestClient를 알게 되었고 유용한 점이 많아 이기회에 사용법을 정리해 둔다.

VSCode에 rest client 설치
VSCode에서 rest client 플러그인을 검색 설치 한다.

 

파일생성
restclient를 사용하기 위해 우선 확장자 'http' 파일을 생성 한다. 그리고 생성한 http 파일을 vscode에서 불러온다.

 

명품 JAVA Programming:귀로 배우는 자바가 아니라 눈으로 몸으로 배우는 자바강좌

기본문법
1) I/F 구분
각 Interface 는 '###' 로 구분 한다.

### signin
 ...
###

### get userlist
 ...
###

2) 변수선언
자주 반복되는 값이나 정보는 아래처럼 변수로 선언하여 I/F 작성시 사용할 수 있다.

### Global values
@url = 192.168.10.100:10000/v1
@bearerToken = eyJ0eXAiOiJKV1QiLCJhb....
@devId = T011
###

위처럼 등록한 변수는 '{{}}' keyword 사용할 수 있다.

Ex)아래 예시처럼 위에서 선언한 url을 변수로 사용

GET http://{{url}}/devices HTTP/1.1

3) GET Method 연동
rest GET Method 연동 방법에 대한 예제로 Authorization이 있는 경우 위 bearerToken을 아래와 같이 등록하면 된다.

### get devices
GET http://{{url}}/devices HTTP/1.1
Content-Type: application/json
Authorization: Bearer {{bearerToken}}
###

 

4) POST Method 연동
rest POST Method 연동 방법에 대한 예제로 Body 부분은 아래와 같이 구성하여 요청할 수 있다.

POST http://{{url}}/devices/{{devId}}/regist HTTP/1.1
Content-Type: application/json
Authorization: Bearer {{bearerToken}}

{
  "devCode":"TB0031",
  "devName":"TB0031-Device",
  "useYn":1
}

5) 실행
실행은 각 Interface 마다 'Send Request' 또는 Play 버튼이 생성되며, click시 우측에 실행 결과가 표시 된다.

​PUT, DELETE의 경우도 위와 같은 과정을 수행 작성하여 실행하면 된다.