API 프록시 설명서 패턴

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

이 주제에서는 Apigee Edge 설명서 샘플에 나와 있는 몇 가지 API 프록시 개발 패턴을 설명합니다. 설명서 샘플을 더 많이 추가할수록 이 주제에 더 많은 패턴을 추가할 계획입니다.

자바스크립트 HTTP 클라이언트 패턴

자바스크립트 HTTP 클라이언트 패턴은 Apigee Edge로 서버 측 매시업을 만드는 데 사용할 수 있는 여러 패턴 중 하나입니다. Apigee의 자바스크립트 객체 모델을 사용하면 자바스크립트 코드를 API 프록시 흐름에 직접 연결할 수 있습니다. 객체 모델의 httpClient 객체를 사용하면 백엔드 서비스를 호출하고 JavaScript를 사용하여 결과를 가져올 수 있습니다.

정책 구성 패턴

정책 구성은 정책을 사용하여 여러 백엔드 대상의 결과를 단일 응답으로 결합할 수 있는 Apigee API 프록시 패턴입니다. 실제로 정책 구성을 사용하면 정책을 사용해 매시업을 만들 수 있습니다.

정책 구성 패턴의 중심에는 ServiceCallout 정책이 있습니다. Service콜아웃 정책은 백엔드 API 또는 서비스에 대한 HTTP 클라이언트 역할을 합니다. 하지만 완전하게 작동하기 위해 ServiceCall은 원격 API 또는 서비스와 의미 있는 상호작용을 할 수 있도록 다른 정책에 의존합니다. 다른 정책은 Service콜에서 보낸 요청 메시지를 생성하고 원격 API 또는 서비스의 응답 메시지에 있는 콘텐츠를 파싱하는 데 사용됩니다.

정책 구성 설명서 예시에서는 AssignMessage, ServiceCallout, ExtractVariables라는 세 가지 정책을 사용합니다. 이러한 정책은 백엔드로 전송하려는 요청 메시지, 메시지를 백엔드로 라우팅하는 클라이언트, 각 API의 응답을 파싱하고 응답 데이터에 사용할 변수를 할당하는 메시지 파서를 캡슐화합니다. 모든 호출이 완료되면 수집된 변수가 결합되어 단일 JSON 객체로 반환됩니다.

다음은 이와 관련된 3가지 정책의 요약입니다.

  • AssignMessage: 요청 메시지를 만들고, HTTP 헤더와 쿼리 매개변수를 채우고, HTTP 동사를 설정합니다.
  • ServiceCallout: AssignMessage 정책으로 생성된 메시지를 참조하고, 외부 호출의 타겟 URL을 정의하고, 타겟 서비스가 반환하는 응답 객체의 이름을 정의합니다.
  • ExtractVariables: 일반적으로 이전 ServiceCall 정책에서 생성된 메시지를 파싱하는 JSONPath 또는 XPath 표현식을 정의합니다. 그런 다음 정책은 Service콜 응답에서 파싱된 값이 포함된 변수를 설정합니다.

정책 구성 패턴을 보여주는 전체 예는 정책 구성 사용을 참조하세요.