Spring API 테스트를 위한 3가지 클라이언트

Spring에서 개발한 API가 제대로 동작하는지 확인하려면 API 테스트가 필요함.
이때 사용할 수 있는 3가지 웹 클라이언트가 있음.

1. Chrome 웹 브라우저

• 간단한 GET 요청 테스트로 API 응답을 간단히 확인할 때 사용

특징

• GET 요청만 가능(URL을 입력하면 자동으로 GET 요청)
• 추가적인 헤더, 바디, 다른 메서드 (POST, PUT, DELETE 등) 사용 불가

사용방법

• 브라우저 주소창에 API URL 입력
• 엔터를 치면 GET 요청을 보내고 JSON 데이터 응답을 확인

사용 예제

• 모든 게시글 조회
  https://jsonplaceholder.typicode.com/posts
• 특정 게시글 조회(id = 1)
  https://jsonplaceholder.typicode.com/posts/1

2. GUI 클라이언트 (Postman)

• 모든 HTTP 요청 가능, GUI 클라이언트
• 다양한 API 테스트를 쉽게 하고 싶을 때

특징

• 모든 HTTP 메서드 지원 (GET, POST, PUT, DELETE 등)
• GUI(그래픽 인터페이스)로 쉽게 요청 생성 가능
• API 테스트 & 문서 관리 기능 포함
• JSON 응답 보기 편함

사용방법

1. Postman 실행
2. HTTP 메서드 선택 (GET, POST, PUT, DELETE 등)
3. URL 입력
4. 필요한 헤더, 바디 추가 후 요청 보내기
5. API 응답(JSON) 확인

사용 예제

• POST 요청 (게시글 생성)
  • URL: https://jsonplaceholder.typicode.com/posts
  • Body (JSON 데이터 전송)

    {
    "title": "foo",
    "body": "bar",
    "userId": 1
    }

• DELETE 요청 (게시글 삭제, id=1)
  • URL: https://jsonplaceholder.typicode.com/posts/1

3. cURL

• 커맨드라인에서 API 요청 테스트
• 스크립트로 자동화 테스트할 때 사용하면 좋음

특징

• 터미널(CLI)에서 HTTP 요청 가능
• 추가적인 헤더, 바디, 인증 정보 등을 쉽게 포함 가능
• GUI 없이 API 자동화 테스트 가능

사용방법

• 터미널(CMD, Git Bash 등) 열기
• cURL 명령어 입력
  • -i : Follow Redirects → 주소가 바뀌면 바뀐주소로 유도하는것
  • -X : Method - GET 과 같은 메서드
  • -H : Header - 헤더, 일반적으로 아래 옵션들 많이 사용
    • Content-Type: application/json → JSON을 역직렬화 하는것
    • Accept: application/xml 혹은 Accept: application/json → 응답 받는 형식을 XML 혹은 JSON
  • -d : Data - POST, PUT 등의 요청을 할때 보낼 Request Body (JSON)
• API 요청 실행 후 응답 확인

사용 예제

• PUT 요청 (게시글 전체 수정, id=1)

  curl -i -X PUT -H 'Content-type: application/json' \
  -d '{"id":1,"title":"foo","body":"bar","userId":1}' \
  https://jsonplaceholder.typicode.com/posts/1

• PATCH 요청 (게시글 일부 수정, id=1)

  curl -i -X PATCH -H 'Content-type: application/json' \
  -d '{"title":"foo"}' \
  https://jsonplaceholder.typicode.com/posts/1