API 테스팅이란?

날짜:

API 테스팅

이번 API 테스팅 문서는 아래와 같은 것들을 다룹니다.

  • API란?
  • API 테스팅이란?
  • API 테스팅 종류
  • API 테스팅 장점
  • API 테스팅에서 정확하게 확인해야 되는 것
  • API 테스팅에 사용되는 도구
  • API 테스팅과 Unit 테스팅에 대한 차이점
  • API 테스팅 시 발생하는 도전 과제
  • API 테스팅을 수행할 때 만나는 버그 유형
  • API 테스팅 Best Practice

API란 ?

API는 약자이며 (Application Programming Interface) 를 의미합니다. API는 소프트웨어 응용 프로그램을 작성하기 위한 일련의 루틴(routine), 프로토콜 및 도구입니다. API는 소프트웨어 프로그램이 다른 소프트웨어 프로그램과 상호 작용하는 방법을 지정합니다.

루틴 : 특정 작업을 수행하는 프로그램. 루틴은 프로시저, 함수 또는 서브 루틴이라고 불림
프로토콜 : 두 시스템 간에 데이터를 전송하기 위한 약속 또는 형식

보다 익숙한 방식으로 예를 들어 API를 설명하겠습니다.

식당에서 웨이터로 API를 가정하십시오. 
레스토랑에서는 메뉴에서 사용할 수 있는 항목을 기준으로 주문합니다. 
식당의 웨이터가 주문을 기록하고 식사를 준비하는 주방에 배달합니다. 
식사가 준비되면 웨이터가 부엌에서 음식을 집어 들고 식탁에 내놓습니다.

이 시나리오에서 웨이터의 역할은 API와 유사합니다. 웨이터와 마찬가지로 API는 소스(source : 요청을 한 곳 - 위 예에서는 고객 / API에서는 웹, 모바일 어플리케이션등) 에서 요청을 가져와서 해당 요청을 데이터베이스로 가져오고 데이터베이스에서 데이터를 가져오고 소스(요청한 곳)에 응답을 전달합니다.

API 테스팅이란?

API 테스팅은 직접 API를 테스트하고 또한 API가 기능의 안정성, 성능, 보안 측면에서 기대치를 충족하는지 API를 확인하기 위한 통합 테스팅의 일환으로 수행되는 소프트웨어 테스팅의 한 유형입니다.

API 테스팅에서 주요 관심사는 소프트웨어 아키텍처의 비즈니스 로직 레이어입니다. API 테스트는 여러 API가 포함된 모든 소프트웨어 시스템에서 수행할 수 있습니다. API 테스팅은 애플리케이션의 룩앤필(보이는 모양과 느낌)에 집중하지 않습니다. API 테스트는 GUI 테스트와 완전히 다릅니다.

UI 테스트가 API 테스트와 어떻게 다른지 살펴보겠습니다.

UI (사용자 인터페이스) 테스트는 응용 프로그램의 그래픽 인터페이스 부분을 테스트하는 것입니다. 주요 초점은 응용 프로그램의 룩앤필 (보이는 모양과 느낌)을 테스트하는 것입니다. 반면에 API 테스팅은 서로 다른 두 소프트웨어 시스템 간의 통신을 테스트하는 것이 가능합니다. 주요 초점은 응용 프로그램의 비즈니스 계층입니다.

API 테스팅 종류

API 테스팅은 전형적으로 다음과 같은 실사례들이 있습니다.

  • 단위 테스트 : 개별 연산의 기능을 테스트합니다.
  • 기능 테스트 : 더 넓은 시나리오의 기능을 테스트하기 위해. 유닛 테스트의 그룹하여 블록으로 테스트하여 결과를 도출합니다. (역자의 주 - 다양한 조건 및 상황을 다 테스팅 하는 블록 테스팅 / 시나리오 기반의 테스팅을 하는 것으로 판단됨)
  • 부하 테스트 : 부하가 발생한 상황에서, 기능 및 성능을 테스트합니다.
  • 런타임 / 오류 감지 : 응용 프로그램을 모니터링하여 예외 및 리소스 누수 같은 문제를 식별합니다.
  • 보안 테스트 : 외부 위협으로부터 API의 구현이 안전하도록 보장합니다.
  • UI 테스트 : 사용자 인터페이스의 모든 측면이 예상대로 작동하는지 확인하기 위해 종단(화면부터 ~ DB까지) 간 통합 테스트의 일환으로 수행됩니다.
  • 상호 운용성 및 WS 준수 테스트 : 상호 운용성 및 WS 준수 테스트는 SOAP API에 적용되는 테스트 유형입니다. SOAP API 간의 상호 운용성은 웹 서비스 상호 운용성 프로파일에 대한 적합성을 확인함으로써 점검됩니다. WS- * compliance(준수)는 WS-Addressing, WS-Discovery, WS-Federation, WS-Policy, WS-Security 및 WS-Trust와 같은 표준이 제대로 구현 및 활용되도록 테스트됩니다.
  • 침투 테스트 : 침입자로부터 응용 프로그램의 취약점을 찾기 위해 사용합니다. 퍼지 테스트 : 강제로 크래시를 발생하기 위해 강제로 시스템에 입력하여 API를 테스트합니다.
  • +논리 테스트 : AI 모델이 논리적으로 혹은 의도한 대로 잘 학습되었는지에 대한 테스트, evaluator를 통해 결과 score로 모델 판독이 있지만 manual/visualize 하게 테스트가 필요하여 이 테스트를 진행할 필요가 있음

API에 대한 일반적인 테스트

API에서 수행하는 일반적인 테스트 중 일부는 다음과 같습니다.

  • 입력 조건을 기반으로 반환값이 유효한지 확인합니다. API 요청에 따라 API의 응답을 검증합니다.
  • API에서 조금이라도 데이터 구조가 변경될 때 시스템에서 API의 결과를 잘 수용하는지 검증합니다.
  • API가 다른 이벤트를 트리거 하는지 또는 다른 API를 호출하는지 검증합니다.
  • 응답 값(return value)이 없을 때 API의 올바른 행위(잘 작동하는지)를 하는지 검증합니다.

API 테스트와 Unit(단위) 테스트의 차이점

Unit(단위) 테스트 :

  • 단위 테스트는 개발 팀에서 수행합니다.
  • 단위 테스트는 화이트 박스 테스트의 한 형태입니다.
  • 단위 테스트는 빌드 전에 먼저 수행됩니다.
  • 단위 테스트에 소스 코드가 관련되어 있습니다.
  • 단위 테스트에서는 테스트 범위가 제한되어 있으므로 테스트를 위해 기본적인 기능 만 고려됩니다

API 테스팅 :

  • QA 팀에서 API 테스트를 수행합니다.
  • API 테스트는 블랙 박스 테스트의 한 형태입니다.
  • API 테스트는 빌드가 된 후에 테스트를 수행됩니다.
  • 소스 코드는 API 테스트에 포함되지 않습니다.
  • API 테스트에서는 테스트 범위가 넓기 때문에 작동하는 모든 문제는 테스트를 위해 고려됩니다

API 테스팅 시 발생하는 도전 과제

API 테스트를 수행하는 동안 우리가 직면한 도전 과제(어려운 점)들은 다음과 같습니다

  • 적절한 매개 변수 및 그 조합 선택
  • 매개 변수를 적절하게 분류
  • 적절한 호출 순서 지정이 필요하므로 테스팅 적용 커버리지가 적절하지 않을 수 있습니다.
  • 출력 확인 및 검증
  • GUI가 없으므로 입력 값을 제공하기가 매우 어렵습니다.

API 테스트를 수행할 때 만나는 버그 유형

API 테스트를 수행할 때 발생하는 이슈들은 다음과 같습니다.

  • 스트레스, 성능 및 보안 문제
  • 중복되거나 누락된 기능들
  • 안정성 문제
  • 부적절한 메시징
  • 호환되지 않는 오류 처리 메커니즘
  • 멀티 스레드 문제
  • 부적절한 오류

API 테스팅 Best Practice

  • 예측한 결과들이 나오는지 테스트할 것
  • API 과부하 테스트를 순차적으로 보냄으로써, 시스템에 스트레스 추가
  • 테스트 카테고리 별 그룹 API 테스트 케이스
  • 완벽한 테스트 커버리지를 위해, 가능한 모든 입력 조합을 사용하여 테스트 케이스 작성
  • 테스트하기 쉽도록 API 함수 호출 우선순위 지정
  • 예상치 못한 문제를 처리하기 위한 테스트 작성
  • 가능한 한 (최대한) API 테스트를 자동화할 것

API 테스팅 시 사용되는 도구

댓글

댓글 쓰기