샘플 API 프록시 사용

Apigee Edge 문서입니다.
Go to the Apigee X documentation.
info

기본 요건

http://enterprise.apigee.com에 계정이 있어야 합니다. http://accounts.apigee.com/accounts/sign_up에서 평가판 계정에 가입할 수 있습니다.

샘플을 사용하려면 다음도 있어야 합니다.

도구 설명
Git 샘플은 GitHub에 있습니다. Git이 설치되어 있지 않으면 GitHub's Git 설정 안내를 참조하세요. Git을 설치하지 않으려면 https://github.com/apigee/api-platform-samples에서 파일을 찾아보고 ZIP 파일을 다운로드하면 됩니다.
Python

Apigee 배포 도구를 실행하려면 Python이 필요합니다. Python은 대부분의 Linux 환경, XCode가 설치된 Mac, Cygwin이 설치된 Windows 머신 및 기타 여러 위치에 있습니다.

Python을 가져오려면 Python 다운로드 페이지를 참조하세요.

curl 샘플 설정 스크립트도 curl을 사용합니다. curl이 설치되어 있고 경로에서 사용할 수 있는지 확인합니다 (which curl 명령어를 실행하여 시스템에서 사용할 수 있는지 확인).
dos2unix Windows에서 Cygwin을 실행하는 경우 dos2unix 유틸리티도 필요할 수 있습니다. (Cygwin 설치 프로그램을 사용하면 유틸리티를 설치할 수 있습니다.)

샘플 다운로드

샘플 파일을 가져오려면 다음 예와 같이 git clone을 사용합니다.

git clone https://github.com/apigee/api-platform-samples.git

샘플 API 프록시 가져오기 및 배포

명령줄에서 샘플을 가져오고 배포합니다.

  1. 샘플을 다운로드한 후 다음 예와 같이 /setup 디렉터리로 이동합니다.
    cd setup
  2. /setup 디렉터리에서 setenv.sh 파일을 찾습니다.
  3. 이 파일을 수정하여 조직, 사용자 이름과 연결된 이메일 주소, API 프록시를 배포할 환경 (prod 또는 test)을 설정합니다.
  4. setenv.sh를 수정한 후 다음을 실행합니다.
    sh deploy_all.sh

    이 스크립트는 모든 API 프록시 샘플을 조직에 배포합니다. (이 프로세스는 3~4 분 정도 걸립니다.) OAuth에 사용되는 API 제품, 개발자, 앱을 배포하라는 메시지를 따릅니다.

  5. 배포 스크립트가 완료되면 sample-proxies 디렉터리로 이동합니다. 디렉터리 sample-proxies에는 샘플 프록시당 하나의 디렉터리가 있습니다. 각 디렉터리에는 샘플 실행에 대한 정보가 포함된 README.md 파일과 샘플을 약간 변경하고 배포한 후 샘플을 호출하여 변경사항이 어떤 영향을 미치는지 확인하는 데 도움이 되는 두 개의 스크립트가 있습니다.
    • invoke.sh: 이 스크립트를 실행하여 배포된 버전의 API 프록시를 호출합니다.
    • deploy.sh: 변경사항을 적용한 후 이 스크립트를 실행하여 API 프록시를 배포합니다.

샘플 API 프록시 호출

각 샘플 프록시에는 배포 후 API 프록시 를 호출하는 데 사용할 수 있는 연결된 셸 스크립트가 있습니다.

/sample-proxies/proxy_name 디렉터리에서 다음을 실행합니다.

sh invoke.sh

이렇게 하면 조직의 테스트 환경에서 실행 중인 프록시가 호출됩니다.

문제 해결

문제 해결 정보는 다음을 참조하세요.

샘플 API 프록시 수정 및 재사용

샘플 프록시의 일반적인 사용법은 수정, 배포, 호출입니다. 이를 통해 약간의 수정을 한 후 응답 메시지에 어떤 영향을 미치는지 확인할 수 있습니다.

샘플 API 프록시를 수정하여 다른 백엔드 서비스를 가리키려면 다음 위치에서 XML 구성 파일을 수정합니다.

/apiproxy/targets/target_name.xml

예를 들어 API 키 샘플이 자체 백엔드 서비스를 가리키도록 하려면 다음 파일을 찾습니다.

/apikey/apiproxy/targets/default.xml

기본 구성이 다음과 같이 http://mocktarget.apigee.net을 가리키는 경우

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

백엔드 서비스가 http://api.myproject.com/에서 제공되는 경우 구성을 다음과 같이 수정합니다.

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

변경사항을 저장한 후 다음 예와 같이 API 프록시를 배포합니다.

sh deploy.sh

다른 API 프록시도 동일한 방식으로 수정하여 기존 대상 서비스에 대해 API 프록시 기능을 사용할 수 있습니다. 그러나 경우에 따라 API 프록시 동작은 특정 메시지 형식에 따라 달라지므로 프록시에 추가 구성 변경이 필요할 수 있습니다.