Newman 설치 방법 및 Postman 컬렉션 Newman에서 실행하기

API 개발자로서, Postman은 API 요청을 테스트하고 자동화하는 데 널리 사용되는 도구임을 잘 알고 있을 것입니다. Postman Newman은 많은 개발자들이 수년간 사용해 온 도구지만, 몇 가지 제한 사항도 존재합니다.

 

이 가이드에서는 Postman 컬렉션을 실행하기 위해 설계된 명령줄 도구인 Newman의 설치 및 사용 방법을 다룰 것입니다. 이 가이드를 따라 Newman을 설치하고 Postman 컬렉션을 실행하는 방법을 배워 API 테스트 프로세스를 자동화할 수 있습니다. A는 강력한 대안으로 Apidog을 추천합니다.

 

무료로 가입하세요 || 지금 다운로드하세요

 

Postman에서 Newman이란 무엇인가요?

Newman은 개발자가 지속적 통합(CI) 환경에서 Postman 컬렉션과 환경을 실행할 수 있게 해주는 명령줄 도구입니다. Postman은 개발자가 API를 설계, 테스트 및 문서화할 수 있게 해주는 인기 있는 API 개발 도구입니다. Newman은 개발자가 Postman 컬렉션과 환경을 사용하여 API 테스트를 자동화할 수 있도록 해주는 도구입니다.

 

Newman을 사용하면 개발자는 API 테스트를 쉽게 자동화하고 API가 예상대로 작동하는지 확인할 수 있습니다. Newman은 다양한 통합 및 플러그인을 지원하여 API 개발에 유용한 도구로 활용됩니다. 그러나 Newman에는 설정 및 구성의 복잡성, 느린 테스트 실행 속도, 대규모 사용에 대한 비용 등의 제한 사항이 있으므로 개발자가 이를 염두에 두어야 합니다.

 

Newman과 Postman의 차이점은 무엇인가요?

Postman과 Newman은 모두 API 개발 도구이지만, 용도가 다릅니다. Postman은 개발자가 그래픽 사용자 인터페이스(GUI)를 사용하여 API를 테스트할 수 있는 데스크톱 애플리케이션입니다. 반면, Newman은 개발자가 지속적 통합(CI) 환경에서 Postman 컬렉션과 환경을 실행할 수 있게 해주는 명령줄 도구로, API 테스트를 자동화하는 데 유용합니다.

 

Postman과 Newman의 또 다른 차이점은 비용입니다. Postman은 무료 버전을 제공하지만, 추가 기능을 제공하는 유료 플랜도 있습니다. 반면, Newman은 오픈소스 도구로 무료로 사용할 수 있습니다.

 

Newman에서 Postman 컬렉션 실행하기

Newman 설치하기
Newman은 Node.js 위에 구축되었습니다. Newman을 실행하려면 Node.js가 설치되어 있어야 하며, Node.js 버전은 v16 이상이어야 합니다. Node.js는 패키지 관리자를 통해 설치할 수 있습니다.

NPM을 사용하는 것은 Newman을 설치하는 일반적이고 쉬운 방법입니다. 터미널에 다음 명령어를 입력하세요.

npm install -g newman

"-g" 플래그를 사용하면 Newman이 시스템에 전역적으로 설치되어, 어디에서든 실행할 수 있습니다.

Newman으로 Postman 컬렉션 실행하기
"newman run" 명령어를 사용하여 실행할 컬렉션을 지정할 수 있습니다. Postman에서 Postman 컬렉션을 JSON 파일로 내보낸 후, 이를 Newman을 사용해 실행하면 됩니다.

newman run mycollection.json

 

추천 읽기:

How to Fix Postman Collection Limits for Free

 

Postman Newman 보너스 팁

CI/CD에서 Newman 사용하기
Newman은 기본적으로 모든 것이 원활하게 실행되면 상태 코드 0을 반환합니다. CI 도구가 Newman's의 종료 코드를 인식하고 빌드를 성공 또는 실패로 처리할 수 있도록 이를 설정할 수 있습니다.

또한, "--bail" 플래그를 사용하면 Newman이 테스트 케이스 오류를 만나면 실행을 중단하고 상태 코드 1을 반환하게 할 수 있습니다. 이 오류는 CI 도구나 빌드 시스템에서 포착되어 적절히 처리될 수 있습니다.

 

Newman을 Node.js 라이브러리로 사용하기
Newman은 Node.js 라이브러리로도 사용 가능하여 개발자가 Node.js 애플리케이션에 API 테스트를 통합할 수 있습니다. Newman을 라이브러리로 사용하면 컬렉션을 프로그래밍 방식으로 실행하고, 테스트 결과에 접근하며, 빌드 프로세스에 테스트를 통합할 수 있습니다.

const newman = require('newman'); // Newman 모듈 임포트

async function runCollection() {
  try {
    await newman.run({
      collection: require('./sample-collection.json'),
      reporters: 'cli'
    });
    console.log('컬렉션 실행 완료!');
  } catch (err) {
    console.error(err);
  }
}

runCollection();

이 예시 코드는 async/await 구문을 사용하여 Newman 실행을 더 간결하고 가독성이 좋게 만듭니다. Newman 모듈을 임포트하고, 비동기 함수 runCollection을 정의하여 컬렉션을 실행합니다. 함수 내에서는 await 키워드를 사용하여 Newman이 실행을 마칠 때까지 기다린 후, 컬렉션이 실행되었다는 메시지를 출력합니다. 오류가 발생하면 이를 잡아 오류 메시지를 출력합니다. 마지막으로 runCollection() 함수를 호출하여 전체 프로그램을 실행합니다.

 

Postman Newman 대안: Apidog
Apidog은 테스트 시나리오를 Apidog CLI, Postman 및 JMeter 형식으로 내보낼 수 있는 기능을 제공하여 API 테스트를 지속적인 통합 프로세스에 쉽게 통합할 수 있게 합니다.

 

Apidog CLI는 명령줄에서 Apidog 테스트 시나리오를 실행하기 위해 특별히 설계된 도구로, 테스트 실행 및 자동화된 테스트 프로세스를 간소화하는 방법을 제공합니다. 테스트 시나리오를 Apidog CLI로 내보내면 개발자는 API 테스트를 빌드 프로세스에 쉽게 통합하고 API가 철저하고 일관되게 테스트되도록 할 수 있습니다.

 

Apidog CLI 외에도 Apidog은 Postman 및 JMeter 형식으로 테스트 시나리오를 내보내는 것을 지원하여 개발자에게 더 큰 유연성을 제공합니다. 이러한 내보내기 옵션을 통해 개발자는 자신에게 가장 적합한 테스트 도구를 선택하고 API 테스트를 개발 워크플로우에 원활하게 통합할 수 있습니다.

 

Apidog CLI 설치 방법
필수 조건: 우선 Node.js를 설치해야 합니다. 권장 버전은 >=v16입니다.

아래 명령어를 사용하여 설치합니다:

npm install -g apidog-cli

npm을 통해 시스템에 Apidog CLI를 전역적으로 설치할 수 있으며, 이를 통해 어디서든 실행할 수 있습니다.

설치가 성공적으로 완료되었는지 확인하려면 다음 명령어를 사용할 수 있습니다:

node -v && apidog -v && which node && which npm && which apidog

설치가 성공하면 위 명령어를 실행했을 때 버전 번호와 설치 경로가 즉시 표시됩니다.

실시간 데이터로 실행하기
"테스트"로 이동하여 원하는 API를 열고 CI/CD 페이지로 전환합니다. 테스트 시나리오가 아직 없다면, 하나를 생성하세요.

 

환경, 테스트 데이터, 루프, 간격 등을 설정하세요. CI/CD 제공자에서 "명령줄"을 선택한 다음 "내보낸 데이터 실행"으로 전환합니다. 여기에서 Newman이 내보낸 데이터를 사용할 수 있습니다.

 

내보낸 테스트 시나리오 실행
apidog run examples/sample.apidog-cli.json -r cli,html,json
테스트 보고서는 apidog-reports 디렉터리에 저장됩니다.

보고서를 사용자 지정하려면 JSON 파일에 있는 결과를 사용하여 보고서를 필요에 맞게 사용자 지정할 수 있습니다.

 

 

/apidog-reports/ 디렉터리는 CLI를 실행한 폴더에서 찾을 수 있습니다. 이 디렉터리에는 HTML 형식의 CLI 테스트 보고서가 포함되어 있습니다.

 

결론

이 가이드에서 설명한 단계를 따르면 이제 Newman을 설치하고 Postman 컬렉션을 실행하는 방법에 대해 잘 이해할 수 있을 것입니다. Newman은 자동화된 API 테스트를 가능하게 하는 명령줄 인터페이스를 제공하여 지속적인 통합 환경에서 작업하는 개발자에게 유용한 도구입니다.

 

하지만 Newman의 대안으로 더 강력한 CI/CD 솔루션을 찾고 있다면 Apidog을 고려해 보시기를 강력히 추천합니다. Apidog은 API 테스트와 문서화에 대한 사용자 친화적인 인터페이스 외에도 강력한 CI/CD 기능을 제공합니다. 테스트 케이스 내보내기, 협업 도구, 자동 API 문서 생성, CI/CD 파이프라인과의 원활한 통합과 같은 기능을 제공하는 Apidog은 API 개발과 테스트 요구 사항을 위한 종합적인 솔루션을 제공합니다.

 

Newman을 계속 사용할지 Apidog을 대안으로 탐색할지는 선택 사항이지만, 두 도구 모두 API 테스트 프로세스를 크게 향상시킬 수 있습니다. 그러나 더 강력한 CI/CD 기능을 갖춘 종합적인 솔루션을 찾고 있다면 Apidog을 고려할 가치가 분명히 있습니다.  

무료로 가입하세요 || 지금 다운로드하세요