REST 범주

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기15분

    • REST 호출의 기능을 확인합니다.

    REST 요청 전송 - 인바운드 - REST API 탐색기

    이 테스트 단계는 REST API 탐색기부터 시작합니다. REST API 탐색기를 사용하여 REST 요청의 HTTP 메서드, 경로, 쿼리 매개변수, 요청 헤더 및 본문을 만들고 지정한 다음 REST 요청을 현재 인스턴스로 보냅니다.

    요청을 테스트한 후에는 자동 테스트 단계 작성 단추가 나타납니다. Create Automated Test Step(자동 테스트 단계 생성)을 클릭하여 테스트 단계를 생성합니다. 이 버튼은 요청이 전송될 때까지 나타나지 않습니다. 요청 페이로드가 최대 요청 페이로드 크기 속성보다 크면 테스트 단계를 생성할 수 없습니다.

    이 테스트 단계는 REST 요청 전송 - 인바운드 테스트 단계와 동일한 테스트 기록을 만듭니다. 테스트 단계를 만든 후에는 돌아가서 REST API 탐색기를 사용하여 테스트를 업데이트할 수 없습니다. 모든 변경 사항은 REST 요청 전송 - 인바운드 테스트 단계 양식에서 이루어져야 합니다.

    이 단계의 일부로 HTTP 응답 유효성 확인이 수행되지 않습니다. 응답 페이로드 크기가 너무 크거나, 요청 파라미터가 잘못되었거나, 요청을 보낼 수 없는 경우 단계가 실패합니다. 어설션 단계를 사용하여 응답의 유효성을 확인합니다.

    이 단계를 사용하여 다른 인스턴스 또는 타사/원격 주소로 요청을 보낼 수 없습니다.

    이러한 입력은 REST API 탐색기용입니다. 표시되는 필드는 선택한 API에 따라 다릅니다. 인스턴스에서 REST API를 사용하는 방법에 대한 자세한 내용은 REST API를 참조하십시오.

    표 1. 입력
    필드 설명
    Namespace 요청의 네임스페이스입니다. 목록에서 선택합니다.
    API 이름 사용할 API입니다. 목록에서 선택합니다.
    API 버전 사용할 API 버전입니다. 목록에서 인스턴스에 사용할 수 있는 버전을 선택합니다.
    경로 매개변수 경로에서 API 이름 뒤의 부분입니다. 경로 파라미터는 일반적으로 허용 가능한 값이 목록에 있는 이름-값 쌍입니다.
    쿼리 매개변수 경로 뒤에 URI에 추가된 쿼리 매개 변수의 이름-값 쌍입니다.

    REST API 탐색기는 URI를 인코딩하므로 쿼리 매개변수와 값을 인코딩할 필요가 없습니다.
    요청 헤더 요청 헤더에 포함된 이름-값 쌍입니다. 인증 헤더는 현재 사용자의 자격 증명을 사용하기 위해 나로 보내기 로 설정됩니다. 프로덕션에서 테스트 단계를 사용하려면 REST 보내기 - 인바운드테스트 단계에서 기본 인증 필드를 변경해야 할 수 있습니다.

    이름이나 값을 인코딩하지 마십시오.
    본문 요청 요청 콘텐츠입니다. 일부 요청에는 본문이 없습니다.

    REST 요청 전송 - 인바운드

    테스트 단계를 생성하여 REST 요청을 현재 인스턴스로 보냅니다. REST 요청의 HTTP 메서드, 경로, 쿼리 매개변수, 요청 헤더 및 본문을 지정합니다.

    이 단계의 일부로 HTTP 응답 유효성 확인이 수행되지 않습니다. 응답 페이로드 크기가 너무 크거나, 요청 파라미터가 잘못되었거나, 요청을 보낼 수 없는 경우 단계가 실패합니다. 어설션 단계를 사용하여 응답의 유효성을 확인합니다.

    이 단계를 사용하여 다른 인스턴스 또는 타사/원격 주소로 요청을 보낼 수 없습니다.

    REST API 사용에 대한 자세한 내용은 REST API를 참조하세요.

    표 2. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    기본 인증 공용 API를 사용하는 경우에는 인증 자격 증명을 제공할 필요가 없습니다.

    비공개 API를 사용하는 경우 테스트를 수행할 때 기본 인증 정보를 제공해야 합니다. 이 필드를 비워 두면 예기치 않은 결과가 나타날 수 있습니다. 예를 들어 response-status 코드는 200 OK 대신 401 Unauthorized일 수 있습니다.

    테스트를 실행할 때 인증 문제를 방지하려면 테스트 단계에 할당할 기본 인증 프로파일을 만들거나 선택해야 합니다.

    REST 테스트 단계를 완전히 활용하려면 사용자에게 web_service_admin 역할이 있어야 합니다. 이 역할이 없으면 인증이 필요한 엔드포인트에 필요한 기본 인증 프로파일을 보거나 설정할 수 없습니다. 이 역할이 없어도 사용자는 공개 API 및 비공개 API에 대한 인증되지 않은 액세스에 대한 REST 테스트 단계를 계속 활용할 수 있습니다. 전체 REST 테스트 단계 액세스의 경우 atf_ws_designer 역할을 사용할 수 있으며 여기에는 atf_test_designer 역할과 함께 web_service_admin 역할이 포함되어 있습니다.
    방법 사용할 HTTP 메서드는 다음과 같습니다.
    • GET
    • POST
    • PUT
    • DELETE
    • PATCH
    경로 사용할 경로입니다. 이 필드는 인스턴스 이름 뒤의 URI 부분만 허용합니다. https://<instance name>을 사용하면 오류가 발생합니다.
    쿼리 매개변수 쿼리 매개변수 이름 및 값입니다. 매개 변수 이름이나 값을 인코딩하지 마십시오.
    머리글 헤더 이름과 값입니다. 헤더 이름이나 값을 인코딩하지 마십시오.
    본문 요청의 본문입니다.

    상태 코드 어설션

    HTTP 응답 상태 코드가 지정된 값과 지정된 관계가 있음을 어설션합니다. 상태 코드와 관계의 숫자 값을 지정합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 3. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    운영 값 간에 수행할 비교:
    • is
    • 일치하지 않음
    • 보다 작음
    • 보다 큼
    • 보다 작거나 같음
    • 보다 크거나 같음
    상태 코드 응답 코드에 대해 테스트할 상태 코드입니다.

    상태 코드 이름 어설션

    HTTP 응답 상태 코드 이름이 지정된 값에 대해 지정된 관계를 갖도록 어설션합니다. 상태 코드 이름 및 관계의 값을 지정합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 4. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    운영 값 간에 수행할 비교:
    • 포함
    • 포함하지 않음
    • is
    • 일치하지 않음
    상태 코드 이름 테스트할 상태 코드 이름입니다.

    응답시간 어설션

    HTTP 응답시간이 지정된 값에 대해 지정된 관계를 가진다는 것을 어설션합니다. 응답 시간 및 관계의 값을 지정합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 5. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    운영 입력한 응답시간과 실제 응답시간 간의 비교:
    • 보다 작음
    • 보다 큼
    응답시간(ms) 실제 응답시간과 비교하는 시간(밀리초)입니다.

    응답 헤더 어설션

    HTTP 응답 헤더가 있거나, 헤더에 지정된 값에 대해 지정된 관계가 있음을 어설션합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 6. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    머리글 헤더 이름입니다.
    운영 값 간에 수행할 비교:
    • 포함
    • 포함하지 않음
    • is
    • 일치하지 않음
    • 비어 있지 않음
    값 테스트에 사용할 요소 값입니다. Operation is가 비어 있지 않으면 표시되지 않습니다.

    JSON 응답 페이로드가 유효함을 어설션함

    응답 페이로드가 유효한 JSON 형식인지 어설션합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 7. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.

    어설션 응답 XML 페이로드가 올바른 형식입니다.

    응답 페이로드가 올바른 형식의 XML인지 어설션합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 8. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.

    XML 페이로드 요소 어설션

    XML 응답 페이로드 요소가 있거나, 지정된 값과 지정된 관계가 있는지 어설션합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 9. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    요소 경로 평가할 요소의 XML 경로입니다. 예를 들어, /result/short_description
    {
  "result": {
    "number": "INC0020001",
    "short_description": "test"
  }
}
    운영 값 간에 수행할 비교:
    • 포함
    • 포함하지 않음
    • is
    • 일치하지 않음
    • 비어 있지 않음
    값 테스트에 사용할 요소 값입니다. Operation is가 비어 있지 않으면 표시되지 않습니다.

    JSON 응답 페이로드 요소 어설션

    JSON 응답 페이로드 요소가 있거나, 지정된 값과 지정된 관계가 있음을 어설션합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    표 10. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    요소 경로 평가할 요소의 SNC 경로입니다. 예를 들어, /result/short_description
    {
  "result": {
    "number": "INC0020001",
    "short_description": "test"
  }
}
    자세한 정보는 JSON 파일 가져오기 를 참조하십시오.
    운영 값 간에 수행할 비교:
    • 포함
    • 포함하지 않음
    • is
    • 일치하지 않음
    • 비어 있지 않음
    값 테스트에 사용할 요소 값입니다. Operation is가 비어 있지 않으면 표시되지 않습니다.

    응답 페이로드 어설션

    HTTP 응답 페이로드가 지정된 값과 지정된 관계가 있음을 어설션합니다. 값과 관계를 지정합니다.

    어설션 단계는 REST 요청 전송 - 인바운드 단계를 즉시 따라야 합니다. REST 요청 전송 - 인바운드 단계 다음에 여러 REST 어설션 단계가 있을 수 있지만 다른 테스트 범주의 단계를 통해 REST 요청 전송 - 인바운드 단계와 어설션 단계를 구분할 수 없습니다.

    주:
    전체 페이로드는 일치 항목을 찾는 데 사용됩니다. 페이로드가 크면 성능에 영향을 줄 수 있습니다.
    표 11. 입력
    필드 설명
    실행 순서 테스트가 이 단계를 실행하는 순서를 지정하는 정수입니다.

    단계를 생성하면 시스템이 각 단계에 증분 값을 자동으로 할당합니다. 이 값을 사용하면 테스트를 만든 순서대로 단계가 실행됩니다. 실행 순서 값을 편집하여 이 기본 순서를 변경할 수 있습니다.
    활성 이 테스트 단계를 사용할 수 있도록 활성화하는 옵션입니다.
    애플리케이션 시스템에서 이 단계를 실행하는 애플리케이션 범위입니다.
    테스트 단계를 추가할 테스트의 읽기 전용 이름입니다.
    단계 구성 단계의 읽기 전용 이름입니다.
    설명 테스트 단계에 대한 설명입니다. 이 필드 값은 테스트 단계의 필드 값에 따라 자동으로 설정됩니다. 이 필드는 테스트 단계가 제출된 후에 나타납니다.
    참고 사항 테스트 단계에 대한 참고 사항입니다.
    운영 값 간에 수행할 비교:
    • 포함
    • 포함하지 않음
    • is
    • 일치하지 않음
    • 비어 있지 않음
    응답 본문 테스트에 사용할 응답 본문의 값입니다.

    응답 페이로드에 나타나는 대로 비교할 이름과 값을 포함해야 합니다. 중괄호를 포함해서는 안 됩니다.

    Operation is가 비어 있지 않으면 표시되지 않습니다.
    응답 페이로드에서 간단한 설명을 확인하려면
    {"result":{"number":"INC0010040","short_description":"Test ATF Incident"}}
    응답 본문에는 다음이 포함되어야 함
    "short_description":"Test ATF Incident"
    이러한 형식은 올바르지 않으며 단계가 실패합니다.
    • {"short_description":"ATF 인시던트 테스트"}
    • "{"short_description":"ATF 인시던트 테스트"}"
    • short_description: ATF 인시던트 테스트
    • short_description:"ATF 인시던트 테스트"