VS Code 확장프로그램(플러그인)추천 : postman같이 request테스트 방법 중 가장 쉬운 rest api 테스트 방법

VSCODE에서 확장프로그램중 REST Client는 PostMan과 같이 외부 API를 테스트 할수 있도록 도와주고 있다 

텍스트 기반이라서 서로 공유가 쉽고 테스트 또한 아주 쉽기 때문에 개발자라면 알아두고 있으면 무조건 이득인 셈이다.

 

1. 설치하기

VS Code의 확장 프로그램 메뉴에서 'rest client'를 검색하여 설치한다.

2. 실행

실행하는 방법은 현재 파일의 확장자가 .http이면 rest.client를 사용해 볼수 있다.

새로운 파일을 ex.http파일로 만들어서 여러가지 테스트를 해봅시다.

 

3. 사용법

간략하게 사용법을 정리해 보겠습니다. 좀더 자세한 내용을 알고 싶다면 공식 문서를 확인해 보는것도 좋은 방법입니다.

* 주의 ) 한문서에 여러개의 요청을 하고 싶다면 ###으로 구분하시면 됩니다.

 

3-1. GET

{Method} {Address} {Version} 형식이지만 Get방식과 http/1.1은 디폴드여서 

{Address}만 입력하고 Request를 할 수 있다

아래 내용을 복사해서 vscode 의 http확장자 파일에 넣으면 된다.

그리고 실행은 주소 위쪽에 Send Request라고 나온다. 눌러주자

GET https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
###
GET https://jsonplaceholder.typicode.com/posts/1
###
https://jsonplaceholder.typicode.com/posts/1

결과

3-2 POST 방식

post 방식은 아래쪽에 Content-Type을 넣어줄 수 있다.

POST https://jsonplaceholder.typicode.com/posts HTTP/1.1
Content-Type: application/json; charset=UTF-8

{
  "name": "name_test",
  "time": "Wed, 1 Oct 2022 11:22:33 GMT"
}

 

3-3 PUT/PATCH

방법은 3-2 POST와 비슷하다.

### PUT
PUT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: application/json; charset=UTF-8

{
  "id": 1,
  "title": "testTitle",
  "body": "test Body",
  "userId": 1
}

### PATCH
PATCH https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: application/json; charset=UTF-8

{
  "title": "test Title"
}

 

4. 변수 사용하기

해당 request들을 관리하기 위해선 변수를 사용할 줄 알아야 합니다. 

변수는 @, {{var}}이런 형식으로 사용합니다.

@baseUrl = https://jsonplaceholder.typicode.com
@name = "test"
POST {{baseUrl}}/posts
Content-Type: application/json; charset=UTF-8

{
  "name": {{name}},
  "time": "Wed, 1 Oct 2022 11:22:33 GMT"
}

 

변수를 지정할 땐 @를 쓰고 사용할 땐 {{변수명}}이렇게 사용하면 됩니다.

 

제가 정리한 기능 말고도 여러 기능이 있지만 꼭 필요한 기능만 정리해 두었습니다.

개발하시다 필요한 기능이 있으면 잘 성명된 글이 많으니 검색해 보면 됩니다. 그럼 감사합니다.

좋은 개발하시기 바랍니다.