뉴먼 설치 및 뉴먼에서 포스트맨 컬렉션 실행하는 방법

API 개발자로서, 당신은 API 요청을 테스트하고 자동화하는 인기 있는 도구인 Postman에 익숙할 것입니다. Postman Newman은 수년 동안 많은 개발자들에게 주요 도구였지만, 한계가 없는 것은 아닙니다.

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

Postman에서 Newman이란?

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

Newman Postman을 사용하면 개발자는 API 테스트를 쉽게 자동화하고 API가 예상대로 작동하는지 확인할 수 있습니다. Newman은 다양한 통합 및 플러그인을 지원하여 API 개발을 위한 다재다능한 도구입니다. 그러나 Newman Postman에는 설정 및 구성의 복잡성, 느린 테스트 실행, 대규모 사용에 따른 비용 같은 몇 가지 한계가 있습니다.

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

읽어볼 만한 추천:

Postman Newman의 추가 팁

CI/CD와 함께 Newman 사용하기

Newman은 기본적으로 모든 것이 순조롭게 실행되면 상태 코드 0으로 종료됩니다. 지속적인 통합(CI) 도구가 Newman의 종료 코드에 반응하고 빌드를 통과하거나 실패하도록 하려면 적절히 구성할 수 있습니다.

또한 "--bail" 플래그를 사용하여 테스트 케이스 오류가 발생하면 상태 코드 1로 실행을 중지하도록 Newman을 설정할 수 있습니다. 이 오류는 CI 도구나 빌드 시스템이 감지하고 조치를 취할 수 있습니다.

Node.js 라이브러리로서 Newman 사용하기

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를 전역적으로 설치하여 시스템의 어떤 위치에서나 실행할 수 있습니다.

npm install -g apidog-cli

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 파일의 결과를 사용하여 필요에 따라 보고서를 조정할 수 있습니다.

CLI를 실행한 폴더에서 /apidog-reports/ 디렉토리도 찾을 수 있습니다. 이 디렉토리는 HTML 형식의 CLI 테스트 보고서를 보관합니다.

결론

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

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

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