API Connect 테스터

온라인에서 편집하기

API Connect 테스터 도구는 API를 테스트하여 테스트 케이스, 테스트 스위트 등을 생성합니다.

이 도구는 API 테스트 및 모니터(ATM) 도구에서 지원되는 작업을 완료합니다. API를 테스트하여 예상대로 작동하는지 확인합니다. 테스트 어설션을 생성하여 API 엔드포인트가 다양한 입력 및 시나리오에 대해 올바른 응답을 표시하는지 확인하는 데 중점을 둡니다.

도구 세부사항
  • API 테스트는 API 관리자의 API 테스트 탭에서 액세스할 수 있습니다.
  • 이 도구는 Smart Generation 기능을 사용하여 테스트 사례를 생성합니다.
API Connect 테스터 도구에서 지원되는 작업은 다음과 같습니다:

테스트 케이스 생성

Generate test case 작업은 제공된 API 또는 OpenAPI 사양 파일에서 테스트 스위트를 생성합니다. API는 초안일 수도 있고 특정 카탈로그에 게시될 수도 있습니다. 제품군의 각 테스트 케이스는 서로 다른 엔드포인트에 해당합니다. 지정된 API 또는 OpenAPI 사양 파일에 대한 테스트 스위트가 있는 경우 해당 테스트 스위트가 삭제되고 새 테스트 스위트가 생성됩니다. 제한 및 오프셋 매개 변수를 사용하여 나열되는 테스트 케이스의 수를 제어할 수 있습니다.

이 작업을 수행하면 테스트 케이스 목록이 링크로 표시되어 API 관리자에서 해당 테스트 케이스로 이동합니다.
참고:
  • 카탈로그 이름을 지정하지 않으면 지정된 이름의 API 초안(사용 가능한 경우)에 대한 테스트 스위트가 생성됩니다. 게시된 API에 대한 테스트 케이스를 생성하려면 카탈로그 이름을 지정합니다.
  • 테스트 스위트가 생성된 후 API의 OpenAPI 사양이 업데이트되면 기존 테스트 스위트를 삭제해야 합니다. 업데이트된 API 사양에 따라 새 테스트 스위트를 만들어야 합니다.
표 1. 매개변수
매개변수 설명 기본값 필수
api_name 테스트 케이스를 만들어야 하는 API의 이름입니다. 없음 선택적
api_file 테스트 케이스를 실행해야 하는 오픈 API 사양의 이름입니다. 없음 선택적
catalog 사용자가 API를 게시한 카탈로그 이름입니다. 없음 선택적
version 게시된 API의 특정 버전 또는 API에 지정된 버전입니다. 없음 선택적
limit 응답에 있는 최대 테스트 케이스 수입니다. 정수 값을 받습니다. 15 선택적
Offset 이 테스트 케이스 수를 건너뛰고 나머지 테스트 케이스를 검색합니다. 정수 값을 받습니다. 0 선택적
프롬프트 예시
  • Generate test case for Swagger-Petstore api
  • Generate test case for Swagger-Petstore api in sandbox
  • Generate test for Swagger-Petstore:1.0.0 api
  • Generate test for Swagger-Petstore api with version 1.0.0 in sandbox
  • Generate test case for Swagger-Petstore api with limit 5 offset 15
  • Generate test case for @bookshop.yaml
다음 작업 제안
Run test case for the test suite {testsuite_name}

테스트 케이스 실행

실행 테스트 케이스는 지정된 테스트 스위트에서 테스트 케이스를 실행하거나 API용으로 만든 테스트 케이스를 실행합니다. 실행 중에 API 호출이 이루어지고 어설션의 유효성이 검사됩니다. API는 초안일 수도 있고 특정 카탈로그에 게시될 수도 있습니다. 제한 및 오프셋 매개 변수를 사용하여 나열되는 테스트 케이스의 수를 제어할 수 있습니다. 이 작업은 테스트 케이스 생성 작업 후에만 수행할 수 있습니다.

이 작업을 수행하는 동안 각 테스트 케이스는 유효한 서버 URL 에서 API 호출을 수행할 수 있는지 확인합니다. 초안 API에서와 같이 URL 서버가 누락된 경우 테스트 케이스가 실행되지 않습니다. 에디터에서 테스트 케이스에 대한 클릭 가능한 링크를 통해 URL 서버를 업데이트하라는 메시지가 표시됩니다. 테스트 케이스에 유효한 서버가 있는 경우 URL, 링크는 테스트 결과를 검토할 수 있는 API 관리자의 테스트 케이스의 보고서 탭으로 이동합니다.
표 2. 매개변수
매개변수 설명 기본값
api_name 테스트 케이스를 실행해야 하는 API의 이름입니다. 없음
api_file 테스트 케이스를 실행해야 하는 오픈 API 사양의 이름입니다. 없음
test_name 실행해야 하는 테스트 케이스의 이름입니다. 없음
testsuite_name 테스트 케이스를 실행해야 하는 테스트 스위트의 이름입니다. 없음
catalog 사용자가 API에 게시한 카탈로그 이름입니다. 없음
version 게시된 API의 특정 버전 또는 API에 지정된 버전입니다. 없음
limit 응답에 표시되는 최대 테스트 케이스 수입니다. 정수 값을 받습니다. 15
Offset 이 테스트 케이스 수를 건너뛰고 나머지 테스트 케이스를 검색합니다. 정수 값을 받습니다. 0
프롬프트 예시
  • run test for AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for Swagger-Petstore api
  • run test for Swagger-Petstore api in sandbox
  • run test for Swagger-Petstore:1.0.0 api
  • run test for Swagger-Petstore api with version 1.0.0 in sandbox
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger-Petstore-1.0.0 test suite
  • run test for Swagger-Petstore api with limit 5 offset 15
다음 작업 제안
Get test status for the {api_name} api
Get test status for the test suite {testsuite_name}

테스트 API

테스트 API 작업은 지정된 API 또는 OpenAPI 사양 파일에 대해 테스트 케이스를 생성하고 실행합니다. API는 초안일 수도 있고 특정 카탈로그에 게시될 수도 있습니다. 제한 및 오프셋 매개 변수를 사용하여 나열되는 테스트 케이스의 수를 제어할 수 있습니다.

이 작업은 이러한 테스트 사례를 클릭 가능한 링크로 표시하여 API 관리자의 테스트 사례의 보고서 탭으로 이동하여 테스트 결과를 검토할 수 있도록 합니다.

표 3. 매개변수
매개변수 설명 기본값
api_name 테스트 케이스를 생성하고 실행해야 하는 API의 이름입니다. 없음
api_file 테스트 케이스를 생성하고 실행해야 하는 오픈 API 사양의 이름입니다. 없음
catalog 사용자가 API를 게시한 카탈로그 이름입니다. 없음
version 게시된 API의 특정 버전 또는 API에 지정된 버전입니다. 없음
limit 응답에 표시되는 최대 테스트 케이스 수입니다. 정수 값을 받습니다. 15
offset 이 테스트 케이스 수를 건너뛰고 나머지 테스트 케이스를 검색합니다. 정수 값을 받습니다. 0
프롬프트 예시
  • test api Swagger-Petstore api
  • test api Swagger-Petstore api in sandbox
  • test api Swagger-Petstore:1.0.0 api
  • test api Swagger-Petstore api with version 1.0.0 in sandbox
  • test api for Swagger-Petstore api with limit 5 offset 15
  • test api for @bookshop.yaml
다음 작업 제안
Get test status for the {api_name} api
 Get test status for the test suite {testsuite_name}

테스트 제품군 나열

테스트 세트 목록 작업은 공급자 조직에 있는 모든 테스트 세트의 목록을 제공합니다.

프롬프트 예시:
list test suites

테스트 사례 나열

테스트 케이스 목록 작업은 지정된 테스트 스위트 또는 API에 대해 존재하는 테스트 케이스의 목록을 표시합니다. API는 초안일 수도 있고 특정 카탈로그에 게시될 수도 있습니다. 제한 및 오프셋 매개 변수를 사용하여 나열되는 테스트 케이스의 수를 제어할 수 있습니다.
[표 4] 매개변수
매개변수 설명 기본값
api_name 생성된 테스트 케이스를 나열할 API 이름의 이름입니다. 없음
catalog 사용자가 API를 게시한 카탈로그 이름입니다. 없음
testsuite_ name 테스트 스위트 내부의 테스트 케이스를 나열할 테스트 스위트의 이름입니다. 없음
limit 응답에 표시되는 최대 테스트 케이스 수입니다. 정수 값을 받습니다. 15
offset 이 테스트 케이스 수를 건너뛰고 나머지 테스트 케이스를 검색합니다. 정수 값을 받습니다. 0
프롬프트 예시
  • list test cases in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • list test cases in Swagger-Petstore api
  • list test cases in Swagger-Petstore api in sandbox
  • list test cases in Swagger-Petstore api with limit 5 offset 15

테스트 모음 삭제

delete test suite 작업은 해당 테스트 스위트 내에서 생성된 모든 테스트 케이스와 함께 테스트 스위트를 삭제합니다.
[표 5] 매개변수
매개변수 설명 필수
testsuite_name 삭제해야 하는 테스트 스위트의 이름입니다. 예
프롬프트 예제
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

테스트 케이스 삭제

delete test case 작업은 테스트 스위트 내에서 특정 테스트 케이스를 삭제합니다.
[표 6] 매개변수
매개변수 설명 필수
test_name 삭제해야 하는 테스트 케이스의 이름입니다. 예
testsuite_name 삭제할 테스트 케이스가 있는 테스트 스위트의 이름입니다. 예
프롬프트 예제
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

테스트 사례 게시

테스트를 구성하고 확인한 후 게시할 수 있습니다. 이 작업은 이름을 지정한 경우 테스트 스위트 내의 특정 테스트 케이스를 게시하고, 테스트 스위트 이름이 지정되지 않은 경우 테스트 스위트의 모든 테스트 케이스를 게시합니다.
표 7. 매개변수
매개변수 설명 기본값 필수
test_name 게시할 테스트 케이스의 이름입니다. 없음 예
testsuite_name 게시해야 하는 테스트 케이스가 있는 테스트 스위트의 이름이 표시됩니다. 없음 예
프롬프트 예시
  • publish test in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • publish test AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

테스트 케이스에 대한 테스트 상태 가져오기

상태 가져오기 작업은 초안이든 특정 카탈로그에 게시된 것이든 관계없이 지정된 API 또는 테스트 스위트에 대한 테스트 케이스의 실행 상태를 제공합니다. 테스트 케이스 수는 제한 및 오프셋 매개 변수를 통해 제어할 수 있습니다.

이 작업은 테스트 상태와 개별 사례 상태에 대한 통합 요약을 제공합니다. 실행된 각 테스트 케이스에 대해 API 관리자에서 테스트 케이스의 보고서 탭으로 연결되는 링크와 함께 성공 및 실패 어설션 횟수를 표시합니다. 테스트 케이스가 실행되지 않은 경우 해당 테스트 케이스의 상태는 특정 테스트 케이스에 대해 Not run yet 로 표시됩니다.
표 8. 매개변수
매개변수 설명 기본값
api_name 테스트 케이스의 상태를 가져와야 하는 API의 이름입니다. 없음
test_name 상태를 가져와야 하는 테스트 케이스의 이름입니다. 없음
catalog 사용자가 API를 게시한 카탈로그 이름입니다. 없음
testsuite_ name 상태를 가져와야 하는 테스트 스위트의 이름입니다. 없음
limit 응답에 표시되는 테스트 케이스의 최대 개수입니다. 정수 값을 받습니다. 15
offset 이 테스트 케이스 수를 건너뛰고 나머지 테스트 케이스를 검색합니다. 정수 값을 받습니다. 0
version 게시된 API의 특정 버전 또는 API에 지정된 버전입니다. 없음
프롬프트 예시
  • get test status for Swagger-Petstore api
  • get test status for Swagger-Petstore api in sandbox
  • get test status for Swagger-Petstore:1.0.0 api
  • get test status for Swagger-Petstore api with version 1.0.0 in sandbox
  • get test status for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • get test status for AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

웹훅 작성

create webhook 작업을 통해 특정 테스트 세트에 대한 웹훅을 생성할 수 있으므로 세트당 여러 개의 웹훅을 생성할 수 있습니다. 이름, 설명, 테스트 스위트 이름을 제공하여 웹훅을 만들 수 있습니다. 이 작업은 생성된 웹훅의 URL 과 함께 웹훅에 액세스하는 데 필요한 키 및 비밀번호를 생성하는 방법에 대한 지침을 보여줍니다.
후크에 액세스하기

API 훅을 사용하려면 API 키와 비밀번호를 생성해야 합니다.

API 키와 비밀번호를 생성하려면 다음 단계를 완료하세요:
  1. 테스트 스위트 > 설정 으로 이동합니다.
  2. API 후크와 키를 선택합니다.
  3. 키 섹션에서 추가를 클릭합니다.
표 9. 매개변수
매개변수 설명 기본값 필수
testsuite_name 훅을 생성해야 하는 테스트 스위트의 이름입니다. 없음 예
name 이 이름으로 훅을 생성해야 합니다. 없음 예
des_hooks 후크에 대한 설명입니다. "" 예
프롬프트 예시
  • create hook with name test-hook for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • create hook with name test-hook with description 'For testing purpose' for the test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

웹훅 목록

이 작업은 특정 테스트 스위트에 대해 만들어진 모든 웹훅을 나열합니다.
표 10. 매개변수
매개변수 설명 필수
testsuite_name 훅을 나열해야 하는 테스트 스위트의 이름입니다. 예
프롬프트 예제
list hooks for test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

웹훅 삭제

이 작업은 지정된 테스트 스위트에서 지정된 이름의 특정 웹훅을 삭제합니다.
표 11. 매개변수
매개변수 설명 필수
name 삭제해야 하는 후크의 이름입니다. 예
testsuite_name 삭제할 후크가 있는 테스트 스위트의 이름입니다. 예
프롬프트 예제
delete hook test-hook in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0