외부 API 호출

[Uechann]

외부 API 호출을 구현하는 다양한 방식에 대해서 비교 및 서술 해주세요.

또한, 외부 API 호출에 대한 테스트 코드는 어떻게 작성하는게 좋을지 서술해주세요

[softmoca]

외부 API를 호출하는 방식은 크게 RestTemplate, WebClient, RestClient, 그리고 선언형 HTTP 인터페이스@HttpExchange나 Feign 정도가 있습니다.

RestTemplate은 오래 써온 동기 방식이지만 Spring 7에서 폐기가 공식 예고돼 7.1에서 deprecated, 8.0에서 제거 예정이라 신규 프로젝트에서는 권장되지 않습니다.
WebClient는 논블로킹,리액티브라 대량 동시 호출이나 스트리밍엔 강하지만 단순 동기 호출 한 군데엔 리액티브 스택을 끌고 와야 해서 과한 면이 있습니다.

그래서 동기 흐름에서 외부 API 하나를 호출하는 일반적인 상황이라면 RestClient를 선호하는데, RestTemplate의 후속이면서 fluent API를 제공하고,
onStatus로 에러 응답을 도메인 예외로 매핑하거나
requestFactory로 타임아웃을 걸고 인터셉터로 재시도,Rate Limit 같은
횡단 관심사를 다루기 직관적이기 때문입니다.

호출 지점이 많아 보일러플레이트를 줄이고 싶을 땐 선언형 인터페이스나 Feign이 유리하지만, 에러 핸들링이나 타임아웃을 세밀하게 제어해야 하는 결제 같은 도메인에선 RestClient가 더 다루기 좋다고 생각합니다.

외부 API 호출 테스트의 경우 특히나 무엇을 검증하는지에 따라 계층을 나누는 것이 좋다고 생각합니다.

서비스 계층 테스트는 우리 비즈니스 로직이 맞는지를 신뢰하고 싶은 영역이라, 외부 호출 포트를 Mock으로 대체해 HTTP는 전혀 건드리지 않고 금액 검증이나 예외 변환 같은 로직만 결정적으로 검증합니다.
예를들어 게이트웨이가 성공을 돌려준다고 가정했을 때 예약이 CONFIRMED로 바뀌는지, 금액이 불일치하면 승인 호출 자체가 일어나지 않는지를 봅니다.

반면 직렬화,인증 헤더,상태코드 매핑, 타임아웃처럼 "실제 통신이 의도대로 동작하는가"는 Mock으로 갈아끼우는 순간 통째로 건너뛰는 부분이라, MockWebServer나 WireMock으로 토스인 척하는 가짜 서버를 세워 어댑터 통합 테스트로 따로 확인합니다.

특히 타임아웃은 응답을 일부러 지연시켜 예외 종류뿐 아니라 우리가 설정한 시간만큼만 기다렸다 끊기는지 경과 시간까지 단언하는 게 의미 있으며, 실제 외부 환경에 직접 붙는 테스트는 깨지기 쉽고 외부 의존성이 커서 CI 자동화보단 수동 확인용으로 두는 편이 안정적이라고 생각합니다.

[koreaioi]

RestTemplate

• 예전부터 사용하던 동기 Http 요청 방식.
• Spring에서 더이상의 개발은 없으며, deprecated 예정.
• 요청 관련 예외 처리를 위해, try-catch 사용 or ResponseErrorHandler구현

RestClient

• 메서드 체이닝을 지원해, 가독성이 좋다.
• 요청 관련 예외 처리를 위해 onStatus(), defaultStatusHandler()같은 도구를 제공.
• 세밀한 조작 지원. (requestInterceptor, requestFactory etc...)
• create(RestTemplate restTemplate)을 지원하기 때문에, 기존의 RestTemplate과 호환 가능

WebClient

• 비동기 + 동기 지원
• 사용을 위해 WebFlux의존성을 추가해야함. netty 기반 이벤트 루프 처리를 위한 thread 관리 등의 리소스가 필요한데, 이는 Spring MVC 프로젝트에서 동기 처리 방식을 사용할 때, 불필요한 요소라고 생각함.

OpenFeign와 @HttpExchange

• 코드가 간결하여 RestTemplate, RestClient, WebClient 사용 시 자주 보이는 중복 코드가 없음.
• 사용이 쉬운 만큼 세밀한 조작 X

---

보호하려는 대상에 외부 API 호출(외부 리소스 진입점)이 필요하다면, 해당 부분을 모킹하고 테스트 코드를 작성
ex PaymentService에서 TossPaymentGateway를 사용하고, PaymentService의 비즈니스 로직에 대한 테스트 코드 작성한다면?? TossPaymentGateway 자체를 모킹

보호하려는 대상이 외부 리소스 진입점(ex TossPaymentGateway)이라면, 외부 리소스 자체를 모킹하는 테스트 코드를 작성
이때, MockWebServer, WireMock을 사용

---

https://spring.io/blog/2025/09/30/the-state-of-http-clients-in-spring
시간 날 때 읽어보면 좋을 거 같습니당

[sangjun121]

외부 API를 호출하는 방식으로는 RestTemplate, RestClient, WebClient와 선언형 HTTP 클라이언트가 있습니다.

1. RestTemplate

스프링에서 오랫동안 사용된 동기 방식의 HTTP 클라이언트입니다. 사용법이 단순하다는 장점이 있지만, 스프링에서 더이상 개선지원을 하지 않고 제거가 예정되어 있기 때문에 권장되지 않습니다. 또한 예외 처리를 직접 처리해야 한다는 특징이 있습니다.

2. RestClient

RestTemplete의 후속 API로 메서드 체이닝방식의 Fluent API를 제공하여 가독성이 좋습니다. 내부 메서드인 onStatus와 defaultStatusHandler를 사용하여 응답상태코드에 따라 예외처리를 쉽게 구현할 수 있습니다. 또한 외부 API 연동시의 타임아웃, 재시도, 로깅과 같은 횡단 관심사도 requestFactory, requestInterceptor를 이용하여 제어할 수 있습니다.
이전 기능인 RestTemplate와 호환이 되기 때문에, 일반적인 동기 환경에서는 사용하는 것이 권장된다고 생각합니다.

3. WebClient

Spring WebFlux에서 제공하는 클라이언트입니다. 비동기와 논블로킹 방식을 지원하기 때문에, 높은 동시성이 필요한 환경에서 큰 장점을 갖습니다. 다만, 작은 스프링 프로젝트에서 단순히 외부 API를 한두번 호출하는 경우 오버엔지니어링이 될 수 있습니다.

4. OpenFeign 및 @HttpExchange

이 두 클라이언트는 선언형 HTTP 클라이언트입니다. 말 그대로, 인터페이스만 정의하면 자동으로 구현체가 생성되어 보일러플레이트를 줄일 수 있습니다. 다만 이런이유로 내부 구현을 쉽게 커스텀할 수 없습니다. 따라서 결제와 같은 도메인에서 타임아웃이나, 예외 처리 정책을 세밀하게 관리해야하는 경우 RestClient가 더 적절합니다.

테스트 전략

외부 API와 연결되는 어뎁터 레이어에 대한 통합테스트가 필요하다고 생각합니다. 실제 HTTP 요청과 응답이 의도대로 동작하는지 검증하기 위해, 가짜 서버를 구축하여 의도된 어플리케이션의 정책이 연결과정에서 실행되는지 검증할 필요가 있다고 생각합니다. 실제 외부 서버를 사용한다면, 네트워크와 외부 서비스의 가용성에 영향을 받기 때문에, CI환경에서 테스트하기에는 불안정합니다. 따라서, 수동으로 검증하거나, 스테이징환경에서 제한적으로 진행하는 것이 올바르다고 생각합니다!

[haeyoon1]

1. 외부 API 호출을 구현하는 다양한 방식에 대해서 비교 및 서술 해주세요.

대표적으로 RestTemplate, RestClient, WebClient, OpenFeign 등이 있습니다.

RestTemplate은 동기 방식의 HTTP 클라이언트로 사용이 단순하지만, 최근에는 잘 사용되지 않습니다.
RestClient는 동기 방식의 HTTP 클라이언트입니다. RestTemplate보다 최신의 API를 제공하고, 일반적인 spring mvc 환경에서 많이 사용됩니다.
WebClient는 비동기, 논블로킹 호출에 적합합니다. 여러 API를 동시에 호출하거나 응답 대기 시간이 긴 경우 유리하지만, 코드가 다소 복잡해질 수 있습니다.
OpenFeign은 인터페이스로 외부 API를 선언하면 구현체를 자동으로 만들어주는 방식입니다. API 호출 코드를 깔끔하게 관리하기 좋지만, 예외 처리나 세부 설정을 이해하고 사용해야 합니다.

외부 API 호출을 구현할 때는 단순히 요청을 보내는 것뿐 아니라
timeout, 예외 처리, 재시도, fallback, 로깅, 인증 헤더 관리 등을 함께 고려해야 합니다.
또한 내가 통제할 수 없기 때문에 실패할 수 있다는 전제로 설계하는 것이 중요합니다.

2. 외부 API 호출에 대한 테스트 코드는 어떻게 작성하는게 좋을지 서술해주세요

테스트 코드는 실제 외부 API에 의존하지 않는 것이 좋다고합니다!
실제 API를 호출하면 네트워크 상태나 외부 서버 장애, 데이터 변경 때문에 테스트가 불안정해질 수 있기 때문입니다.

서비스 로직 테스트에서는 외부 API 클라이언트를 Mock으로 대체해, 성공/실패 응답에 따라 우리 서비스가 올바르게 동작하는지 검증합니다.
HTTP 요청 자체를 검증하고 싶다면 WireMock이나 MockWebServer 같은 테스트용 서버를 사용해 URL, method, header, body, 응답 매핑, 예외 처리를 확인할 수 있습니다.