Visual Sutdio(VSCode) REST Client

REST Client

Visual Studio Code(이하 VSCode)의 REST Client는 Visual Studio Code의 확장 프로그램 중 하나입니다. 이를 통해 HTTP 요청을 보내고 응답을 받을 수 있다. 이를 통해 RESTful API를 테스트하고 디버깅하는 등의 작업을 수행할 수 있다.

REST Client를 사용하면 텍스트 파일 안에서 HTTP 요청을 작성하고 실행할 수 있으며, 보통 .http 또는 .rest 확장자를 가진 파일 안에 요청을 작성하고, 이를 실행하여 요청을 보내고 응답을 확인할 수 있다.

설치

마켓플레이스에서 rest client를 검색하여 설치한다.

사용법

.rest, .http 확장자 파일을 생성후 아래와 같이 작성한다.

GET https://api.github.com
content-type: application/json

{
    "key": "value"
}

위의 예제에서 GET은 HTTP 메서드를 나타내고, https://api.github.com는 요청할 URL을 나타냅니다. 그리고 Content-Type: application/json은 요청의 헤더를 나타내며, 마지막으로 { "key": "value" }는 요청의 Body 를 나타낸다.

또한 위의 예제를 작성하게 되면 Send Request가 표시되며 이 버튼을 선택시 응답값을 확인할 수 있으며, 또한 단축키 윈도우(Ctrl + Alt + R), MacOS(Cmd + Alt + R) 단축키로도 사용할 수 있다.

Request 여러개일 경우

###으로 여러개의 Request 들을 구분하면 된다.

###
# Github API 리스트를 조회합니다.
GET https://api.github.com
content-type: application/json

###
# 특정 사용자의 Repository 의 정보를 조회합니다.
GET {{url}}/repos/sample/sample.github.io
content-type: @ContentType

###을 구분선으로 Request들을 작성하였다.

변수

변수를 사용할수 있는 환경 변수(Environment Variables), 파일 변수(File Variables), Prompt Variables, 요청 변수(Request Variables) 시스템 변수(System Variables) 방법이 존재하며, 해당 글에서는 파일 변수, 시스템 변수의 사용법만 설명한다.

파일 변수

@url = https://api.github.com
@ContentType = "application/json"

@GIT_TOKEN = {{$dotenv GIT_TOKEN}}

GET https://api.github.com
content-type: {{ContentType}}

같은 파일내에서 @variableName = variableValue와 같이 사용한다.

요청 변수(Request Variables)

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

###
# @name login
POST {{baseUrl}}/api/login HTTP/1.1
Content-Type: application/x-www-form-urlencoded

###
# @name createComment
POST {{baseUrl}}/comments HTTP/1.1
Authorization: {{authToken}}
Content-Type: application/json

{
    "content": "fake content"
}

해당 변수는 응답값을 저장할 수도 있다. 이러한 상황은 인증관련 Token 값을 처리할 경우 `Authorization: {{authToken}} 이러한 방식으로 이용할 수 있다.

시스템 변수(System Variables)

같은 레벨에 .env 파일을 이용하여 작성할 수 있다.

@url = https://api.github.com
@ContentType = "application/json"

@GIT_TOKEN = {{$dotenv GIT_TOKEN}}

GET https://api.github.com
Authorization: token {{GIT_TOKEN}}
content-type: {{ContentType}}

마치며

VSCODE의 REST Client는 간단한 테스트나 API 디버깅을 수행하는 데 유용하며, 요청을 빠르게 테스트하고 결과를 확인할 수 있다. 그러기에 통합 개발 환경 내에서 작업할 수 있어 편리함을 가질 수 있다.

위에서 설명하지 못한 기능들을 더 다양하게 지원하고 있으니 rest client에 접속하셔서 해당 확장 프로그램에 대해서 알아보고 사용해봐도 좋을거 같다.

참고

https://marketplace.visualstudio.com/items?itemName=humao.rest-client