API 프록시 개발의 핵심 사항

이 페이지는 ApigeeApigee Hybrid에 적용됩니다.

Apigee Edge 문서 보기

이 주제에서는 API 프록시의 몇 가지 기본 특성과 자세한 정보를 볼 수 있는 링크를 나열합니다.

API는 한 애플리케이션이 다른 애플리케이션의 기능을 사용하기 위한 진입점입니다. API 프록시를 구현하여 API 만들기

Apigee에서는 API 프록시 로직을 클라이언트 코드의 요청에 응답하여 실행되는 일련의 단계로 구성하여 API 프록시를 구현합니다. 리소스 경로가 있는 URL, HTTP 동사, 본문 요구사항 등이 포함된 엔드포인트를 정의하여 API 프록시를 클라이언트에 노출시킵니다.

이는 API 프록시라고 하지만 클라이언트 코드 측면에서는 API입니다.

API 프록시 개요는 API 및 API 프록시 이해를 참조하세요.

흐름을 사용하여 API 프록시 로직 시퀀스 정렬

모든 애플리케이션에서 데이터는 조건 로직으로 안내되어 애플리케이션을 통해 이동합니다. Apigee에서 처리 경로는 흐름으로 구성됩니다. 흐름은 API 프록시의 처리 경로를 구성하는 단계입니다. 흐름은 Apigee가 클라이언트에서 백엔드 리소스로, 다시 클라이언트에 이르는 특정 위치의 로직과 동작을 적용할 수 있도록 사용자에게 장소를 제공하는 방식입니다.

흐름에 대한 자세한 내용은 흐름을 사용하여 프록시 실행 방법 제어를 참조하세요.

API 프록시로 생성된 흐름 변수를 통해 상태 데이터에 액세스

API 프록시는 실행 상태를 나타내는 변수에 액세스할 수 있습니다. 이 변수는 API 프록시 및 정책을 구성하는 XML에서 액세스할 수 있습니다. 또한 자바, 자바스크립트, Python과 같은 절차적 언어로 API 프록시를 확장할 때도 액세스할 수 있습니다.

이러한 변수는 Apigee에 의해 보관됩니다. 일부 변수는 기본적으로 존재하는데 HTTP 요청의 일부라는 이유 등으로 API 프록시가 수행하는 작업이기 때문입니다. 로직 요구사항을 충족하기 위해 자체 변수를 만들 수도 있습니다.

변수에 대한 자세한 내용은 흐름 변수로 프록시 상태 관리를 참조하세요.

API 프록시 조건부 실행 가능

대부분의 프로그래밍 언어와 마찬가지로 API 프록시에서는 코드를 조건부로 실행할 수 있습니다. 조건은 보통 API 프록시 상태 기반이며 흐름 변수를 통해 액세스할 수 있습니다. 예를 들어 사용자 에이전트를 확인한 다음 그에 따라 요청을 처리하는 조건이 있을 수 있습니다.

조건부 실행에 대한 자세한 내용은 흐름 변수가 있는 조건을 참조하세요.

정책을 사용하여 API 프록시에서 대부분의 로직 구현

API 프록시에 추가하는 대부분의 로직은 정책으로 패키징됩니다. 정책은 보안 또는 트래픽 관리와 같은 기능 영역의 로직을 캡슐화하는 Apigee 구성요소입니다. 기본 논리의 속성을 설정하는 정책을 XML로 구성합니다. 흐름 내에서 '단계' 시퀀스로 정책을 정렬하여 API 프록시가 프록시 목표에 가장 적합한 순서로 로직을 실행하도록 합니다.

정책에 대한 자세한 내용은 정책이란 무엇인가요?를 참조하세요.

재사용 가능한 기능 집합 포함 가능

API 프록시에 코드의 다른 위치(예: 다른 API 프록시)에서 사용될 로직이 포함된 경우 여러 위치에서 호출에 대한 로직을 수집할 수 있습니다. 예를 들어 다른 API 프록시에서 호출하는 공유 흐름에 보안 로직을 그룹화하여 API 프록시 간의 중복을 줄일 수 있습니다.

공유 흐름에 대한 자세한 내용은 재사용 가능한 공유 흐름을 참조하세요. API 프록시 체이닝에 대한 자세한 내용은 API 프록시 체이닝을 참조하세요.

디버그 도구로 프록시 디버깅 가능

Apigee에는 디버깅 및 테스트를 수행할 때 API 프록시의 실행 흐름을 검사하기 위해 사용할 수 있는 디버그 도구가 포함되어 있습니다. 이 도구는 요청에 대해 실행되는 각 API 프록시 단계를 시각적으로 표시합니다. 디버거와 같이 각 단계에서 API 프록시 상태를 구성하는 변수 값 목록을 볼 수 있습니다.

디버그 도구를 사용한 디버깅에 대한 자세한 내용은 디버그 도구를 참조하세요.

API 프록시 오류를 결함으로 처리

오류 핸들러를 구성하여 API 클라이언트에 반환되는 오류를 맞춤설정할 수 있습니다. 오류 핸들러를 사용하면 오류가 사용자 자체 코드에서 비롯되었는지 또는 포함된 구성요소(예: 정책)에서 비롯되었는지 여부의 오류 메시지를 제어할 수 있습니다.

자세한 내용은 오류 처리를 참조하세요.