lisakim0 / postman-ko

  • Public
  • 0 runs
Playground Examples README Versions

초보자를 위한 Postman 완전 정복 가이드: 프로처럼 API 테스트 시작하기

현대의 소프트웨어 및 웹 개발 세계에서 “API”(Application Programming Interface)는 다양한 서비스를 서로 연결하는 핵심적인 역할을 합니다. 백엔드 개발자로서 API를 만들든, 프런트엔드 개발자로서 API를 호출하든, 또는 QA 테스터로서 API의 정확성을 검증하든, API 작업을 쉽고 빠르게 도와주는 도구는 필수적입니다.

그리고 API 관리 도구에 대해 이야기할 때, 가장 먼저 떠오르는 이름은 단연 Postman일 것입니다. Postman은 개발자가 API를 생성, 테스트, 관리 및 공유할 수 있도록 돕는 강력하고 널리 사용되는 플랫폼입니다. API 개발의 세계에 이제 막 발을 들인 초보자에게 Postman 사용법을 배우는 것은 API의 작동 방식을 이해하고 팀과 원활하게 협업하는 데 도움이 되는 중요한 기본 기술입니다.

이 글은 초보자를 위한 안내서 역할을 할 것입니다. 설치부터 인터페이스 이해, 첫 번째 요청(Request) 전송, 그리고 컬렉션(Collections)과 환경(Environments)을 사용한 작업 관리까지 차근차근 알려드릴 것입니다. 이 글을 다 읽고 나면, 여러분의 프로젝트에서 Postman을 즉시 사용할 수 있을 만큼 탄탄한 기본 지식을 갖추게 될 것입니다.

Postman에 대해 알아보기 전: 더 강력한 대안, Apidog을 소개합니다

apidog.com

하지만 Postman의 사용법을 본격적으로 배우기 전에, 최근 각광받고 있는 매우 흥미로운 차세대 도구인 Apidog을 먼저 소개해 드리고 싶습니다.

Apidog은 단순한 “Postman 대체재”가 아닙니다. 개발자에게 필요한 여러 도구를 하나로 통합한 올인원(All-in-One) API 플랫폼입니다. Postman, Swagger, Mock Server 등 여러 도구를 오가며 작업할 필요 없이, API 디자인(Design), 개발(Develop), 테스트(Test), 문서화(Document) 등 모든 작업을 단 하나의 프로그램 안에서 처리할 수 있다고 상상해 보십시오.

왜 Apidog이 초보자(그리고 전문가)에게 매력적인 선택일까요?

  1. 하나로 모든 것을 해결 (All-in-One): Apidog은 Postman(API 테스트), Swagger(API 문서화), Mock Server(모의 데이터 생성)의 기능을 하나로 통합하여 작업의 복잡성을 줄이고 시간을 절약해 줍니다.
  2. 현대적이고 직관적인 UI/UX: Apidog의 인터페이스는 초보자가 더 쉽게 배우고 사용할 수 있도록 깔끔하고 현대적으로 설계되었습니다.
  3. 향상된 팀 협업: Apidog은 팀 협업에 중점을 두고 만들어졌습니다. API 데이터가 실시간으로 동기화되어 프런트엔드, 백엔드, QA 등 팀원 모두가 항상 최신 버전의 정보를 공유할 수 있습니다.
  4. 스마트한 Mock Server 생성: API 디자인을 기반으로 모의 데이터(Mock Data)를 제공하는 Mock Server를 즉시 생성할 수 있습니다. 이를 통해 프런트엔드 개발자는 백엔드 API 개발이 완료될 때까지 기다릴 필요 없이 바로 작업을 시작할 수 있습니다.
  5. 테스트 케이스 자동 생성: Apidog은 여러분이 디자인한 API 명세서를 기반으로 테스트 케이스를 자동으로 생성하여, 더 쉽고 포괄적인 테스트를 가능하게 합니다.

만약 여러분이 아직 특정 도구에 익숙해지지 않은 신입 개발자라면, 장기적인 관점에서 Apidog으로 시작하는 것이 더 나은 선택일 수 있습니다. 처음부터 현대적이고 효율적인 개발 워크플로우를 제공하기 때문입니다. 하지만 Postman은 여전히 많은 조직에서 표준 도구로 사용되고 있으므로, 그 기본 사용법을 익히는 것 또한 매우 가치 있는 일입니다. 따라서 다음 섹션부터는 Postman의 사용법을 자세히 알아보겠습니다.

1단계: Postman 설치 및 설정

Postman을 시작하는 방법은 매우 간단합니다.

  1. Postman 다운로드: Postman 공식 웹사이트(www.postman.com/downloads/)에 접속하여 자신의 운영체제(Windows, macOS, Linux)에 맞는 버전을 다운로드합니다.
  2. 프로그램 설치: 화면의 지시에 따라 설치를 진행합니다. 일반적으로 “Next”를 몇 번 클릭하면 완료됩니다.
  3. 계정 생성 (권장): 프로그램을 처음 열면 무료 계정을 만들라는 안내가 나옵니다. 계정을 만들면 컬렉션, 환경, 기록 등 여러분의 작업 내역을 여러 기기에서 동기화할 수 있고, 향후 팀과의 협업도 훨씬 수월해지므로 계정을 만드는 것을 강력히 추천합니다.

2단계: Postman 인터페이스 이해하기 (User Interface)

Postman을 처음 열면 수많은 구성 요소에 압도당하는 느낌을 받을 수 있습니다. 걱정하지 마세요. 가장 중요한 부분부터 하나씩 알아보겠습니다.

  1. 사이드바 (Sidebar): 왼쪽의 이 공간에서는 다음과 같은 주요 구성 요소를 관리합니다.
    • Collections (컬렉션): 관련된 API 요청(Request) 그룹을 저장하는 폴더와 같습니다. 요청들을 체계적으로 관리하고 쉽게 재사용할 수 있게 해줍니다.
    • Environments (환경): Base URL, API Key와 같은 변수(Variables) 세트를 저장하는 데 사용됩니다. 이를 통해 개발(Development), 스테이징(Staging), 프로덕션(Production) 등 다양한 환경을 쉽게 전환하며 작업할 수 있습니다.
    • History (기록): 여러분이 보냈던 모든 요청이 기록되어 있어, 과거의 요청을 다시 확인하거나 재사용하기 편리합니다.
  2. 요청 빌더 (Request Builder): 여러분의 주 작업 공간입니다.
    • HTTP Method (메서드): GET, POST, PUT, DELETE 등 전송할 요청의 종류를 선택하는 드롭다운 메뉴입니다.
    • Request URL (요청 URL): 호출하려는 API의 엔드포인트 URL을 입력하는 곳입니다.
    • Send (전송 버튼): 작성한 요청을 서버로 보내는 버튼입니다.
  3. 요청 상세 탭 (Request Tabs): URL 입력창 아래에 위치하며, 요청에 대한 세부 정보를 설정할 수 있습니다.
    • Params: URL 뒤에 붙는 쿼리 파라미터(예: ?id=123)를 설정합니다.
    • Authorization: API Key, Bearer Token 등 인증 정보를 설정합니다.
    • Headers: 추가적인 HTTP 헤더 값을 설정합니다.
    • Body: 요청과 함께 전송할 데이터를 입력하는 곳입니다 (POST, PUT 요청에 매우 중요). form-data, x-www-form-urlencoded, raw (JSON, XML, Text), binary 등 다양한 형식을 선택할 수 있습니다.
  4. 응답 창 (Response Window): 가장 아래쪽에 위치하며, “Send” 버튼을 누른 후 서버가 반환한 결과를 보여줍니다.
    • Body: 서버로부터 받은 핵심 데이터를 보여줍니다. 주로 JSON이나 XML 형식입니다.
    • Cookies: 서버가 보낸 쿠키를 보여줍니다.
    • Headers: 응답의 HTTP 헤더를 보여줍니다.
    • Status: 응답의 상태 코드(예: 200 OK, 404 Not Found, 500 Internal Server Error), 응답 시간, 데이터 크기 등을 보여줍니다.

3단계: 나의 첫 번째 요청 보내기 (GET 요청)

가장 좋은 학습 방법은 직접 해보는 것입니다. 서버로부터 데이터를 “가져오는” 데 사용되는 GET 메서드로 첫 번째 요청을 보내보겠습니다. 테스트용 무료 API 서비스인 JSONPlaceholder를 사용하겠습니다.

  1. Postman에서 + 버튼을 눌러 새 탭을 엽니다.
  2. HTTP 메서드 드롭다운 메뉴에서 GET이 선택되어 있는지 확인합니다.
  3. 요청 URL 입력창에 다음 URL을 입력합니다. https://jsonplaceholder.typicode.com/posts/1 이 URL은 id가 1인 “post” 데이터를 요청한다는 의미입니다.
  4. 파란색 Send 버튼을 클릭합니다.

잠시 기다리면… 아래 응답 창에 결과가 나타날 것입니다.

결과 분석:

  • Status: 200 OK가 표시될 것입니다. 이는 요청이 성공했고 서버가 정상적으로 데이터를 반환했다는 의미입니다.
  • Body: Body 탭에서 다음과 같은 JSON 형식의 데이터를 볼 수 있습니다. json { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto" } 이것이 바로 우리가 요청했던 id가 1인 post의 데이터입니다.

축하합니다! 여러분은 첫 번째 API 요청을 성공적으로 보냈습니다.

4단계: 새로운 데이터 생성하기 (POST 요청)

다음으로, 서버에 새로운 데이터를 “생성”하기 위해 “전송”하는 POST 메서드를 사용해 보겠습니다.

  1. 새 탭을 열거나 기존 탭을 사용합니다.
  2. HTTP 메서드를 GET에서 POST로 변경합니다.
  3. URL을 다음과 같이 변경합니다. https://jsonplaceholder.typicode.com/posts 특정 데이터를 지정하는 것이 아니라 새로운 데이터를 생성할 것이므로 URL 끝에 /1을 붙이지 않습니다.
  4. 서버로 보낼 데이터를 입력해야 하므로, Body 탭을 클릭합니다.
  5. raw를 선택하고, 오른쪽의 드롭다운 메뉴에서 JSON을 선택합니다.
  6. 아래 텍스트 영역에 생성하려는 JSON 데이터를 다음과 같이 입력합니다. json { "title": "My First Post", "body": "This is a test post from Postman!", "userId": 101 }
  7. Send 버튼을 클릭합니다.

결과 분석:

  • Status: 이번에는 “데이터가 성공적으로 생성됨”을 의미하는 상태 코드인 201 Created가 표시됩니다.
  • Body: 여러분이 방금 전송한 데이터와 함께, 서버가 새로 생성해 준 id(예: id: 101)가 포함된 JSON 응답을 볼 수 있습니다.

5단계: Collection으로 요청 정리하기

여러 개의 API를 다루기 시작하면, 요청들이 여기저기 흩어져 있어 혼란스러워지기 쉽습니다. 컬렉션(Collections)이 이 문제를 해결해 줍니다.

  1. 컬렉션 생성: 왼쪽 사이드바에서 Collections 탭을 클릭한 후, + 버튼 또는 Create Collection을 클릭합니다.
  2. 컬렉션의 이름을 “JSONPlaceholder API”와 같이 지정합니다.
  3. 요청을 컬렉션에 저장: 이전에 작업했던 요청 탭(GET. POST)으로 돌아가면 Send 버튼 옆에 Save 버튼이 있습니다. 이 버튼을 클릭합니다.
  4. Save Request 창이 나타나면, 요청의 이름(예: “Get Single Post”)을 지정하고 방금 만든 “JSONPlaceholder API” 컬렉션을 선택한 후 저장합니다.
  5. POST 요청도 동일한 방법으로 “Create New Post”라는 이름으로 저장합니다.

이제 사이드바를 확인하면 두 요청이 컬렉션 안에 깔끔하게 정리된 것을 볼 수 있습니다. 앞으로 이 요청들을 쉽게 재사용하거나 팀과 공유하고, 심지어 전체 테스트를 실행하는 것도 가능해집니다.

6단계: 변수와 환경을 사용하여 유연성 높이기

우리가 만든 두 요청에는 https://jsonplaceholder.typicode.com이라는 공통된 부분이 있습니다. 이를 Base URL이라고 합니다. 만약 나중에 이 API의 URL이 변경된다면, 모든 요청의 URL을 하나하나 수정해야 하므로 매우 번거롭습니다. 환경(Environments)과 변수(Variables)가 이 문제를 해결해 줍니다.

  1. 환경 생성: 왼쪽 사이드바에서 Environments 탭을 클릭하고 +를 눌러 새 환경을 만듭니다.
  2. 환경 이름을 “Development”로 지정합니다.
  3. 나타나는 테이블에 새 변수를 만듭니다.
  4. Save(디스크 모양 아이콘) 버튼을 누릅니다.
  5. 환경 사용 설정: Postman 우측 상단에 “No Environment”라고 표시된 드롭다운 메뉴를 클릭하고, 방금 만든 “Development”를 선택합니다.
  6. 변수 사용하기: “Get Single Post” 요청으로 돌아가서 URL을 수정합니다. 기존: https://jsonplaceholder.typicode.com/posts/1 변경: {{baseUrl}}/posts/1
  7. Postman은 {{variableName}} 구문을 사용하여 현재 활성화된 환경에서 변수 값을 가져옵니다.
  8. Send 버튼을 다시 눌러보면, 이전과 동일하게 작동하는 것을 확인할 수 있습니다!

이제 만약 스테이징이나 프로덕션 서버로 전환해야 한다면, 새로운 환경(“Production”)을 만들고 올바른 baseUrl을 입력한 뒤, 환경만 전환하면 됩니다. 모든 요청의 URL을 일일이 수정할 필요가 전혀 없습니다.

결론

이 글을 통해 우리는 Postman 사용에 필요한 모든 기본 사항을 배웠습니다. 설치, 인터페이스 이해, GET 및 POST 요청 전송, Collections를 이용한 정리, 그리고 Environments와 Variables를 통한 작업 유연성 확보까지 다루었습니다. 이것은 단지 시작일 뿐입니다. Postman에는 테스트 스크립트 작성, 컬렉션 자동 실행(Collection Runner), Mock Server 구축 등 훨씬 더 많은 고급 기능들이 있습니다.

Postman 사용 능력은 여러분의 API 작업에 있어 튼튼한 기반이 될 것입니다. 그리고 실력이 향상됨에 따라, 여러분의 전체 API 개발 워크플로우를 한 단계 더 끌어올려 줄 수 있는 Apidog과 같은 새로운 도구에도 열린 마음을 가지는 것을 잊지 마십시오. API의 세계로 떠나는 여러분의 여정을 응원합니다