JavaScript - 07. Postman사용

Postman

Postman은 API 개발 및 테스트를 위한 플랫폼으로, API 엔드포인트를 쉽게 테스트하고 디버그할 수 있습니다.\

 

다음의 링크를 통해 Postman을 설치합니다.

https://www.postman.com/downloads/

Download Postman | Get Started for Free

 

Postman을 사용하는 주요 이유는 다음과 같습니다.

 

1. 간편한 API 테스트

 

Postman은 직관적인 사용자 인터페이스를 제공하여 API 요청을 쉽게 만들고 보낼 수 있습니다. URL, 헤더, 바디 등의 요 청 파라미터를 쉽게 조작하여 다양한 시나리오를 테스트할 수 있습니다.

 

2. 다양한 HTTP 메서드 지원

 

Postman은 GET, POST, PUT, DELETE 등의 다양한 HTTP 메서드를 지원하여 API의 모든 종류의 요청을 테스트할 수 있습니다.

 

3. 콜렉션 관리

 

Postman은 콜렉션을 사용하여 API 요청을 그룹화하고 조직화할 수 있습니다. 콜렉션은 API의 여러 엔드포인트를 논리적으로 구성하여 관리하기 용이합니다.

 

4. 환경 관리

 

Postman은 환경 변수를 사용하여 여러 개의 환경을 관리할 수 있습니다. 각 환경은 변수를 사용하여 다른 엔드포인트 또는 토큰을 지정할 수 있어, 동일한 요청을 다양한 환경에서 테스트할 때 유용합니다.

 

5. 스크립트 기능

 

Postman은 JavaScript를 사용하여 요청과 응답을 조작할 수 있는 스크립트 기능을 제공합니다. 이를 통해 동적인 요청 생성, 응답 검증, 환경 변수 조작 등을 수행할 수 있습니다.

 

6. 테스트 자동화

 

Postman은 테스트 스크립트를 작성하여 API 요청의 성공 또는 실패를 자동으로 검증할 수 있습니다. 이를 통해 반복적인 테스트를 자동화하고 테스트 결과를 쉽게 파악할 수 있습니다.

 

Postman설치까지 마쳤다면 API 요청에 Postman을 활용해보겠습니다.

 

1. post

 

 

자바스크립트 코드를 위와 같이 입력 후 package.json 의 내용을 다음과 같이 입력합니다.

이때 package.json에 없는 요인들이 있다면 npm i ~ 를 이용하여 설치합니다.

start에 파일명 1_post를 작성하여 해당 파일이 서버에 접속하도록 합니다. 

package.json

터미널에 npm start를 입력합니다.

postman으로 http 요청하면 다음과 같이 값을 반환받을 수 있습니다.

 

 

2. error

아래와 같은 페이지를 마주한 적이 있을 것입니다. 이번에는 아래와 같은 404를 응답을 send하여 사용자가 에러가 발생함을 알 수 있도록 합니다.

에러가 발생하면 사용자가 알 수 있도록 res.sendStatus(404) 코드를 입력합니다.

 

package.json

GET)

http://localhost:8080/file1

 

/file1

 

 

http://localhost:8080/file2

/file2

 

http://localhost:8080/file3

file3

 

http://localhost:8080/file4

file4

 

 

3. Route

- 특정 URL에 대한 미들웨어 및 라우팅 로직을 모듈화하고 그룹화할 수 있음
- 가독성을 향상시키고 유지 보수를 용이하게 함
- route() 메서드는 Router 객체를 반환. 해당 객체로 특정 URL 경로에 대한 라우팅을 설정

 

라우팅 분리 전과 후로 나누어 비교해보도록하겠습니다.

 

http://localhost:8080/posts

 

라우팅 분리 전

package.json

GET)

 

 

POST)

 

 

PUT)

 

DELETE)

 

 

 

http://localhost:8080/member/:id

 

라우팅 분리 후

 

route를 사용하기 위해 routes폴더를 새로 만들어 post, user 자바스크립트 파일을 만들어 사용해보겠습니다.

post

user

package.json

 

 

1. express 모듈과 morgan 모듈을 가져옵니다. morgan은 HTTP 요청 로그를 기록하는 데 사용됩니다.

 

2. userRouter, postRouter를 가져와 각각 /users, /post 경로에 대한 라우팅을 설정합니다.

 

/post 입니다.

 

GET)

POST)

 

 

PUT)

 

 

DELETE)

 

 

/users 입니다.

 

GET)

 

 

POST)

PUT)

 

DELETE)