환경 관리

API 요청을 수행할 때 개발, 테스트, 프로덕션 환경 간 전환이 필요한 경우가 많습니다. Apidog에서는 다양한 환경으로 요청을 편리하게 보낼 수 있습니다. 인터페이스 오른쪽 상단에서 원하는 환경을 클릭하여 선택하기만 하면 됩니다.

Apidog 환경은 두 가지 핵심 요소로 구성됩니다.

Base URL: 요청 전달 대상을 유지합니다.

변수: 요청 또는 스크립트에서 참조할 수 있는 변수 그룹입니다.

환경 간 전환 시 Base URL과 환경 변수는 모두 현재 환경에 정의된 값을 사용합니다.

환경 생성

환경 관리 열기

인터페이스 오른쪽 상단의 환경 관리 버튼 ≡을 클릭하십시오.

새 환경 생성

왼쪽 목록의 마지막 항목인 새 환경을 클릭하십시오.

환경 구성

새 환경의 이름을 입력하십시오. Base URL과 변수를 추가하십시오.

저장

저장을 클릭하십시오.

환경 선택

새 환경을 사용하려면 인터페이스 오른쪽 상단의 환경 선택기에서 해당 환경을 선택하십시오. 이렇게 하면 해당 환경이 활성 환경이 되며, 모든 변수가 환경에 지정된 값으로 설정됩니다.

TIP

Apidog는 환경과 Base URL을 명확하게 분리하여 관리합니다. 환경은 서로 다른 배포 단계(개발, 테스트, 프로덕션)를 나타내며, Base URL은 각 환경 내에서 구성됩니다. 이러한 분리는 여러 환경 전반에서 여러 서비스 또는 마이크로서비스를 관리할 때 유연성을 제공합니다.

반면 Apidog의 환경은 각 Base URL을 단일 환경으로 취급하는 것이 아니라, 개발, 테스트, 프로덕션과 같은 실제 환경을 직접 반영합니다.

Base URL

Base URL은 Apidog 환경의 주요 기능입니다. Apidog에서 엔드포인트 경로는 일반적으로 슬래시(/)로 시작하며 Base URL을 포함하지 않습니다. 요청을 보낼 때 Apidog는 대상 Base URL을 엔드포인트 경로 앞에 추가합니다.

표준화된 Base URL 형식은 프로토콜로 시작하며 끝의 슬래시(/)는 제외합니다.

예시:

https://127.0.0.1

http://abc.com/v1

각 Base URL은 특정 모듈에 해당합니다. 대부분의 경우 엔드포인트는 해당 모듈의 Base URL을 사용하여 요청을 보냅니다.

예를 들어 프로덕션 환경에서 기본 모듈의 Base URL이 http://abc.com/v1이고 엔드포인트 경로가 /pet인 경우, 프로덕션 환경에서 요청을 보낼 때 실제로 전송되는 요청 URL은 다음과 같습니다.

http://abc.com/v1/pet

TIP

엔드포인트 경로가 http:// 또는 https://로 시작하는 경우 Base URL은 추가되지 않습니다. 그러나 엔드포인트에 전체 URL을 하드코딩하는 것은 일반적으로 권장되지 않습니다.

BASE_URL 변수

Apidog에는 현재 환경의 "Default Server"에 대한 Base URL을 저장하는 BASE_URL이라는 특수 환경 변수가 있습니다. 일반적으로 이 변수를 직접 사용하는 것은 권장되지 않습니다.

사용자 지정 스크립트의 경우:

권장: 현재 엔드포인트의 Base URL을 가져오려면 pm.request.getBaseUrl()을 사용하십시오.

피해야 함: 엔드포인트가 "Default Server"를 사용하지 않는 경우 Base URL을 올바르게 가져오지 못할 수 있으므로 pm.environment.get('BASE_URL') 사용은 피하십시오.

BASE_URL이라는 이름의 환경 변수를 수동으로 생성하면 시스템에 미리 정의된 BASE_URL보다 우선합니다.

참고: 스크립트는 Base URL 구성 자체를 수정할 수 없습니다. pm.environment.set('BASE_URL', 'My_url') 명령은 BASE_URL이라는 이름의 변수만 생성합니다.

모듈에서 여러 Base URL 사용

프로젝트의 엔드포인트가 여러 Base URL(예: 마이크로서비스)에 연결되어야 하는 경우, Apidog에서 여러 모듈을 사용하는 것이 가장 좋은 관리 방법입니다.

예시 시나리오:

사용자 엔드포인트: https://user.example.com

주문 엔드포인트: https://order.example.com

제품 엔드포인트: https://product.example.com

설정 단계:

모듈 생성

API 폴더 트리 상단에서 서비스에 해당하는 여러 모듈을 추가하십시오.

Base URL 구성

환경 관리에서 각 모듈의 Base URL을 설정하는 필드를 확인할 수 있습니다. 각 환경의 URL을 입력하고 저장을 클릭하십시오.

모듈 Base URL 설정

모듈의 루트 폴더 설정에서 해당 모듈의 엔드포인트가 사용할 Base URL을 선택하십시오.

기본 설정: 해당 모듈에 나열된 첫 번째 Base URL을 사용합니다(권장).

수동 지정: 다른 Base URL을 수동으로 선택합니다. (대부분의 경우 권장되지 않습니다.)

상속

하위 폴더 또는 개별 엔드포인트에서도 Base URL을 지정할 수 있습니다.

상위 항목에서 상속: 상위 폴더를 따릅니다(기본값).

수동 지정: 특정 항목에 대해 재정의합니다.

요청 보내기

설정이 완료되면 보내기를 클릭하기만 하면 됩니다. Apidog는 모듈 및 환경 설정을 기반으로 적절한 Base URL을 결정합니다.

환경 변수 추가

환경에 변수를 추가할 때 두 가지 값을 지정할 수 있습니다.

초깃값: 팀과 공유됩니다.

현재 값: 사용자 컴퓨터에 로컬로 저장됩니다.

변수 사용에 대해 자세히 알아보십시오.

환경 간 전환

Apidog는 워크벤치 오른쪽 상단의 환경 선택기에 현재 환경을 표시합니다. 요청을 수행하거나 스크립트를 실행할 때마다 Apidog는 선택한 환경의 모든 변수에 대해 현재 값을 사용합니다.

전환하려면 선택기에서 다른 환경을 선택하기만 하면 됩니다.

TIP

엔드포인트 vs. 요청

Apidog에서:

엔드포인트: API 사양입니다(경로는 일반적으로 /로 시작합니다).

요청: 실제로 전송되는 HTTP 요청입니다(전체 URL 포함).

환경에 정의된 서비스는 엔드포인트에 적용됩니다. 임시 디버깅을 위해 요청 탭을 사용할 때(Postman과 유사) 필요한 경우 {{Base_url}} 구문을 사용할 수 있습니다.

환경 마이그레이션

Apidog에서 변수의 초깃값은 팀 내에서 동기화되지만, 현재 값은 로컬에만 저장됩니다. 즉, 현재 값은 다른 장치로 이전되지 않습니다.

Apidog는 컴퓨터 간 환경(로컬 현재 값 포함)을 마이그레이션할 수 있도록 내보내기/가져오기 기능을 제공합니다.

내보내기

환경 관리에서 환경 옆의 ... 위에 마우스를 올리고 내보내기를 클릭하여 JSON 파일을 받으십시오.

가져오기

대상 컴퓨터에서 환경 관리를 열고 ... 위에 마우스를 올린 다음 가져오기를 클릭하고 JSON 파일을 선택하십시오.

환경의 가시성 범위

공유하고 싶지 않은 변수를 위해 비공개 환경을 생성할 수 있습니다.

환경 설정 오른쪽 상단에서 가시성 범위를 설정하십시오.

공유: 팀에 표시됩니다(기본값).

비공개: 본인에게만 표시됩니다.

TIP

비공개 환경은 다른 환경과 동일한 서비스 목록(Base URL)을 공유합니다. 비공개 환경에서 서비스를 추가하거나 제거하면 모든 환경에 동시에 영향을 줍니다.

FAQ

사용자 지정 스크립트에서 서비스 Base URL을 가져오는 방법은 무엇입니까?

현재 엔드포인트의 Base URL을 가져오려면 pm.request.getBaseUrl()을 사용하십시오.

환경 생성#

Base URL#

모듈에서 여러 Base URL 사용#

환경 변수 추가#

환경 간 전환#

환경 마이그레이션#

환경의 가시성 범위#

FAQ#

환경 생성

Base URL

모듈에서 여러 Base URL 사용

환경 변수 추가

환경 간 전환

환경 마이그레이션

환경의 가시성 범위

FAQ