POSTMAN : API 테스트의 기초

이번에 POSTMAN을 사용하여 공부하면서 배운 내용을 여러분과 공유하고자 합니다. 특히 백엔드 개발을 목표로 시작 하시는 분들에게 유용한 정보가 되기를 바라며 포스팅 시작하겠습니다.

 

왜 백엔드 개발자에게 POSTMAN이 필수일까?

1. API 테스트 및 디버깅: 개발한 API를 즉시 테스트하고 오류를 빠르게 찾을 수 있다.
2. API 문서화: 팀원들과 쉽게 API 스펙을 공유할 수 있다.
3. 다양한 환경 테스트: 개발, 스테이징, 운영 환경을 쉽게 전환하며 테스트할 수 있다.
4. 자동화된 테스트: 반복적인 API 테스트를 자동화하여 시간을 절약할 수 있다.
5. 보안 테스트: 다양한 인증 방식을 테스트하고 보안 취약점을 발견할 수 있다.
6. 성능 모니터링: API 응답 시간을 체크하여 성능 이슈를 조기에 발견할 수 있다.
7. 클라이언트 시뮬레이션: 실제 클라이언트 없이도 다양한 API 호출 시나리오를 테스트할 수 있다.

---

1. POSTMAN 설치하기

• postman.com에서 다운로드 
• 운영체제에 맞는 버전 선택 및 설치
• 설치 후 POSTMAN 실행

64-bit (개발환경에 맞게)로 다운로드 하는 것이 보편적임

 

2. 첫 번째 API 요청 보내기

• URL 입력: https://jsonplaceholder.typicode.com/posts/1
• HTTP 메소드: GET 선택
• Send 버튼 클릭

GET 요청 결과에 대해 200 OK

3. POST 요청 보내기

• URL: https://jsonplaceholder.typicode.com/posts
• HTTP 메소드: POST 선택
• Body 탭 선택 > raw > JSON
• JSON 데이터 입력:

{
  "title": "POSTMAN 테스트",
  "body": "블로거 pch가 POSTMAN으로 보낸 첫 POST 요청입니다.",
  "userId": 1
}

 

주소 입력창 아래 Body 카테고리의 raw를 JSON (기본값일 확률이 높다)을 선택한 후 컨트롤러에 맞는 값 입력

그 후, Send 버튼을 클릭하여 결과값을 확인합니다.

Id 발급 등 절차가 이뤄졌음을 확인

4. 파라미터 사용하기

• URL: https://jsonplaceholder.typicode.com/comments
• Params 탭에서 KEY: postId, VALUE: 1 입력
• 자동으로 변경된 URL 확인: https://jsonplaceholder.typicode.com/comments?postId=1
• Send 버튼 클릭

parameter를 변경

바뀐 것을 확인할 수 있습니다. 

파라미터를 왜 사용하는가? (아래 접은 글)

파라미터를 사용하는 이유와 상황:

1. 데이터 필터링: API에서 특정 조건에 맞는 데이터만 가져오고 싶을 때 사용합니다. 예를 들어, 이 예제에서는 postId가 1인 댓글만 조회하고 있습니다. 이는 특정 게시물의 댓글만 보고 싶을 때 유용합니다.
2. 페이지네이션: 대량의 데이터를 여러 페이지로 나누어 조회할 때 사용합니다. 예: ?page=1&limit=10
3. 정렬: 데이터의 정렬 순서를 지정할 때 사용합니다. 예: ?sort=date&order=desc
4. 검색: 특정 키워드로 데이터를 검색할 때 사용합니다. 예: ?search=keyword
5. 버전 관리: API의 버전을 지정할 때 사용할 수 있습니다. 예: ?version=v2
6. 옵션 설정: 응답 형식이나 추가 정보 포함 여부 등을 설정할 때 사용합니다. 예: ?format=json&include_metadata=true

 파라미터를 사용함으로써 클라이언트는 서버에 더 구체적인 요청을 보낼 수 있고, 서버는 이에 따라 필요한 데이터만 효율적으로 처리하여 반환할 수 있습니다. 이는 네트워크 트래픽을 줄이고 응답 속도를 개선하는 데 도움이 됩니다.

 실제 개발 상황에서는 사용자의 입력이나 애플리케이션의 상태에 따라 이러한 파라미터 값을 동적으로 변경하여 API 요청을 보내게 됩니다. POSTMAN에서 파라미터를 쉽게 추가하고 수정할 수 있어, API 테스트 시 다양한 시나리오를 빠르게 확인할 수 있습니다.

---

 지금까지 우리는 POSTMAN의 기본적인 사용법을 알아보았습니다. GET 요청으로 데이터를 조회하고, POST 요청으로 새로운 데이터를 생성해보았으며, 쿼리 파라미터를 사용하여 특정 조건의 데이터를 필터링하는 방법도 배웠습니다. 이러한 기본 기능만으로도 여러분은 대부분의 RESTful API를 테스트하고 사용할 수 있습니다.

 

마무리하며

 POSTMAN은 이외에도 헤더 설정, 인증 처리, 환경 변수 사용, 테스트 스크립트 작성 등 더 많은 고급 기능을 제공합니다. 이번 글에서 배운 기초를 토대로, 앞으로 실제 프로젝트에서 POSTMAN을 활용해보시기 바랍니다. API 개발과 테스트 과정에서 POSTMAN이 얼마나 강력한 도구인지 직접 경험하실 수 있을 것입니다. 추후에 더 다양한 설정과 기능 사용에 대해 포스팅 해보며 공부해 보겠습니다.