안티패턴: 서비스 콜아웃 정책을 사용하여 No Target API 프록시에서 백엔드 서비스 호출

Apigee X 문서를 보고 있습니다.
Apigee Edge 문서 보기

API 프록시는 백엔드 서비스를 위한 관리형 퍼사드입니다. 기본 API 프록시 구성은 ProxyEndpoint(API 프록시의 URL 정의)와 TargetEndpoint(백엔드 서비스의 URL 정의)로 이루어집니다.

Apigee는 이 패턴을 바탕으로 정교한 동작을 빌드할 수 있는 유연성을 제공합니다. 예를 들어 API가 클라이언트 요청을 백엔드 서비스로 보내기 전에 처리하는 방식을 제어하는 정책을 추가하거나 클라이언트로 전달하기 전에 백엔드 서비스에서 받은 응답을 조작할 수 있습니다. 서비스 콜아웃 정책을 사용하여 다른 서비스를 호출하고, 자바스크립트 코드를 추가하여 커스텀 동작을 추가하고, 백엔드 서비스를 호출하지 않는 API 프록시를 만들 수도 있습니다.

안티패턴

서비스 콜아웃을 사용하여 대상 엔드포인트로 가는 경로가 없는 API 프록시에서 백엔드 서비스를 호출하는 것은 기술적으로 가능하지만 외부 서비스 성능에 대한 분석 데이터가 손실될 수 있습니다.

대상 경로가 포함되지 않은 API 프록시는 요청 메시지를 TargetEndpoint로 전달할 필요가 없는 경우에 유용할 수 있습니다. 대신 ProxyEndpoint가 필요한 모든 처리를 수행합니다. 예를 들어 ProxyEndpoint는 API 서비스의 키/값 저장소에 대한 조회에서 데이터를 검색하고 백엔드 서비스를 호출하지 않고 응답을 반환할 수 있습니다.

다음과 같이 API 프록시에서 null 경로를 정의할 수 있습니다. 

<RouteRule name="noroute"/>

null 경로를 사용하는 프록시는 대상 백엔드 서비스를 호출하지 않으므로 '대상 없음' 프록시입니다.

아래 예시에서와 같이 외부 서비스를 호출하기 위해 서비스 콜아웃을 대상 없음 프록시에 추가하는 것은 기술적으로 가능합니다.

<!-- /antipatterns/examples/service-callout-no-target-1.xml -->
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProxyEndpoint name="default">
    <Description/>
    <FaultRules/>
    <PreFlow name="PreFlow">
        <Request>
            <Step>
                <Name>ServiceCallout-InvokeBackend</Name>
            </Step>
        </Request>
        <Response/>
    </PreFlow>
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
    <Flows/>
    <HTTPProxyConnection>
        <BasePath>/no-target-proxy</BasePath>
        <Properties/>
        <VirtualHost>secure</VirtualHost>
    </HTTPProxyConnection>
    <RouteRule name="noroute"/>
</ProxyEndpoint>

하지만 프록시는 외부 서비스 동작에 대한 분석 정보(예: 처리 시간 또는 오류율)를 제공할 수 없으므로 외부 서비스의 성능을 평가하기 어렵습니다.

영향

  • 오류 코드, 응답 시간, 목표 성능 등 외부 서비스와의 상호작용에 대한 분석 정보를 사용할 수 없습니다.
  • 서비스 콜아웃을 호출하기 전이나 후에 요구되는 특정 로직은 전체 프록시 로직의 일부로 포함되므로 이해하고 재사용하기 어렵습니다.

권장사항

API 프록시가 단일 외부 서비스와만 상호작용하는 경우 프록시는 백엔드 서비스가 API 프록시의 대상 엔드포인트로 정의된 기본 디자인 패턴을 따라야 합니다. 대상 엔드포인트에 대한 라우팅 규칙이 없는 프록시는 ServiceCallout 정책을 사용하여 백엔드 서비스를 호출해서는 안 됩니다.

다음 프록시 구성은 위의 예시와 동일한 동작을 구현하지만 권장사항을 따릅니다. 

<!-- /antipatterns/examples/service-callout-no-target-2.xml -->
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProxyEndpoint name="default">
    <Description/>
    <FaultRules/>
    <PreFlow name="PreFlow">
        <Request/>
        <Response/>
    </PreFlow>
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
    <Flows/>
    <HTTPProxyConnection>
        <BasePath>/simple-proxy-with-route-to-backend</BasePath>
        <Properties/>
        <VirtualHost>secure</VirtualHost>
    </HTTPProxyConnection>
    <RouteRule name="default">
        <TargetEndpoint>default</TargetEndpoint>
    </RouteRule>
</ProxyEndpoint>

서비스 콜아웃을 사용하여 대상 엔드포인트를 호출하기 전이나 후에 외부 서비스를 호출하려는 매시업 시나리오를 지원합니다. 서비스 콜아웃은 대상 엔드포인트 호출을 대체할 수 없습니다.

추가 자료