이 페이지는 Cloud Translation API를 통해 번역되었습니다.

API를 사용하여 API 프록시 배포

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

모든 조직에는 고유한 소프트웨어 개발 수명 주기(SDLC)가 있습니다. 종종 을 사용하여 API 프록시 배포를 백엔드 서비스에 사용되는 프로세스와 동기화하고 조정합니다.

이 주제에서 설명하는 Edge API 메서드는 API 프록시를 통합하는 데 사용할 수 있습니다. 조직의 SDLC에 통합할 수도 있습니다 이 API는 일반적으로 스크립트 또는 코드를 작성하는 데 사용됩니다. API 프록시를 배포하거나 한 환경에서 다른 환경으로 API 프록시를 마이그레이션하는 다른 애플리케이션도 배포하거나 마이그레이션하는 대규모 자동화된 프로세스입니다.

Edge API는 SDLC (또는 다른 사람의 경우)에 대해 어떤 가정도 하지 않습니다. 오히려 개발 팀에서 조정하여 자동화를 위해 수행할 수 있는 원자적 함수를 노출합니다. API 개발 수명 주기를 최적화할 수 있습니다

자세한 내용은 Edge API를 참조하세요.

Edge API를 사용하려면 호출에서 본인을 인증해야 합니다. 이 작업은 다음 방법 중 하나를 사용합니다.

OAuth2 (퍼블릭 클라우드만 해당)
SAML (퍼블릭 및 프라이빗 클라우드)
기본 인증 (권장되지 않음, 퍼블릭 및 프라이빗 클라우드)

이 주제에서는 API 프록시 관리를 위한 API 집합에 중점을 둡니다.

동영상: API 배포 방법을 알아보려면 이 짧은 동영상을 확인하세요.

API와 상호작용

다음 단계에서는 API와의 간단한 상호작용을 설명합니다.

조직의 API 나열

조직의 모든 API 프록시를 나열하는 것으로 시작할 수 있습니다. ( EMAIL:PASSWORD 및 ORG_NAME 항목 지침은 다음을 확인하세요. Edge API 사용

curl -u EMAIL:PASSWORD \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/apis

샘플 응답:

[ "weatherapi" ]

API 가져오기

조직의 모든 API 프록시에서 GET 메서드를 호출할 수 있습니다. 이 호출은 API 프록시의 사용 가능한 모든 버전을 표시합니다.

curl -u EMAIL:PASSWORD -H "Accept: application/json" \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/apis/weatherapi

샘플 응답:

{
  "name" : "weatherapi",
  "revision" : [ "1" ]
}

이 메서드가 반환하는 유일한 세부정보는 API 프록시 이름과 관련 버전을 입력합니다. API 프록시는 구성 번들로 구성됨 할 수 있습니다. 버전은 구성 업데이트를 관리하기 위한 가벼운 메커니즘을 제공합니다. 확인할 수 있습니다 버전은 순차적으로 번호가 매겨지므로 API 프록시의 이전 버전 또한 API 프록시의 버전을 프로덕션 환경에서 테스트 환경에서 해당 API 프록시의 새 버전을 계속 생성 환경입니다 준비가 되면 API 프록시의 상위 버전을 prod 환경에서 이전 버전의 API 프록시에 대한 테스트 환경을 테스트합니다.

이 예시에서는 API 프록시가 방금 생성되었으므로 버전이 1개만 있습니다. API로 사용 반복적인 구성 및 배포의 수명 주기를 거치며 증분됩니다. 직접 API 호출을 사용하여 배포하면 선택적으로 API 프록시의 버전 번호입니다. 때로는 사소한 변경을 했을 때 버전을 증분합니다

API 버전 가져오기

API 버전 (예: api.company.com/v1)은 자주 발생하지 않습니다. API 버전을 증분하는 것은 개발자들에게 이전 버전과의 API에 의해 노출된 외부 인터페이스의 서명에 큰 변화가 있었습니다.

API 프록시 버전은 API 프록시와 연결된 증분 번호입니다. 구성할 수 있습니다 API 서비스는 이전의 버전을 되돌릴 수 있도록 구성 버전을 유지관리합니다. kubectl 구성을 수정할 수 있습니다 기본적으로 API 프록시의 버전은 자동으로 API 프록시 가져오기 API를 사용하여 API 프록시를 가져올 때마다 증가합니다. 만약 API 프록시의 버전을 증분하지 않으려면 Update API 프록시 버전 API를 사용합니다. Maven을 사용하여 배포하는 경우 clean 또는 update 옵션(Maven 플러그인에 설명되어 있음) 추가 정보를 참고하세요.

권장사항: API 프록시의 세부 프로필을 가져오는 방법은 다음과 같습니다. 특정 버전 번호에 대해 GET 메서드를 호출합니다.

예를 들어 API 프록시 버전 1에서 GET 메서드를 호출하여 세부정보 뷰를 가져올 수 있습니다.

curl -u EMAIL:PASSWORD -H "Accept:application/json" \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/apis/weatherapi/revisions/1

샘플 응답

{
  "configurationVersion" : {
    "majorVersion" : 4,
    "minorVersion" : 0
  },
  "contextInfo" : "Revision 1 of application weatherapi, in organization {org_name}",
  "createdAt" : 1343178905169,
  "createdBy" : "andrew@apigee.com",
  "lastModifiedAt" : 1343178905169,
  "lastModifiedBy" : "andrew@apigee.com",
  "name" : "weatherapi",
  "policies" : [ ],
  "proxyEndpoints" : [ ],
  "resources" : [ ],
  "revision" : "1",
  "targetEndpoints" : [ ],
  "targetServers" : [ ],
  "type" : "Application"
}

이러한 API 프록시 구성 요소는 API 프록시 구성 참조에 자세히 설명되어 있습니다.

Google Cloud 콘솔의 환경

API 프록시가 요청을 올바르게 수신하고 전달하도록 구성되면 이를 배포할 수 있습니다. 하나 이상의 환경에 연결할 수 있습니다 일반적으로 test에서 API 프록시를 반복한 후 준비가 되면 API 프록시 버전을 prod로 승격합니다. 종종 더 많은 옵션이 더 많이 있다는 것을 API 프록시 버전을 테스트할 수 있습니다. 프로덕션 환경에서 반복 작업을 수행합니다

API 프록시는 환경에 배포될 때까지 호출할 수 없습니다. kubectl 명령어를 프로덕션에 API 프록시 버전을 배포했다면 prod URL을 있습니다.

환경 나열 방법

Apigee Edge의 모든 조직에는 2개 이상의 환경(test 및 prod)이 있습니다. 이 임의적으로 구별할 수 없습니다. 이 문서의 목표는 여러분이 사용 중인 API 프록시가 제대로 작동하는지 확인하는 것이 중요합니다.

각 환경은 실제로는 네트워크 주소일 뿐이므로 작업 중인 API 프록시와 런타임에 앱에서 액세스하는 API 프록시입니다.

환경은 데이터와 리소스의 분리도 제공합니다. 예를 들어 다른 캐시와 동일한 캐시가 있는 경우, 해당 캐시에서 실행되는 API 프록시만 환경입니다

Google Cloud 콘솔의 조직

curl -u EMAIL:PASSWORD \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/environments

샘플 응답

[ "test", "prod" ]

드림

배포 살펴보기

배포는 환경에 배포된 API 프록시의 버전입니다. API deployed 상태에 있는 프록시는 네트워크를 통해 해당 환경의 <VirtualHost> 요소

API 프록시 배포

API 프록시는 배포될 때까지 호출할 수 없습니다. API 서비스는 RESTful API를 노출 API에 액세스할 수 있습니다

한 환경에 API 프록시 버전 1개만 배포할 수 있습니다. 따라서 배포된 버전을 배포 취소해야 합니다 새 번들의 배포 여부를 제어할 수 있습니다. 기존 버전을 덮어쓸지 여부를 결정합니다.

Apigee Edge 문서입니다.
Apigee X 문서로 이동 정보

먼저 기존 버전의 배포를 취소합니다. 다음 인스턴스의 환경 이름과 버전 번호를 지정하세요. 배포 취소하려는 API 프록시:

curl -X DELETE \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/environments/ENV_NAME/apis/API_NAME/revisions/REVISION_NUMBER/deployments \
  -u EMAIL:PASSWORD

그런 다음 새 버전을 배포합니다. API 프록시의 새 버전이 이미 있어야 합니다.

curl -X POST -H "Content-type:application/x-www-form-urlencoded" \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/environments/ENV_NAME/apis/API_NAME/revisions/REVISION_NUMBER/deployments \
  -u EMAIL:PASSWORD

드림

경고: 이 방법을 사용하면 약간의 지연이 발생할 수 있습니다. 첫 번째 버전이 배포 취소된 시점과 새 버전이 배포된 시점 사이의 시간 사이의 값입니다. 기간 중 HTTP 코드 5XX을 사용하면 앱에서의 호출이 거부될 수 있습니다. 이것이 문제가 된다면 일반적으로 프로덕션 환경에 배포되는 경우 원활한 배포 옵션을 사용하세요 참조하세요.

원활한 배포 (다운타임 없음)

배포 중 다운타임 가능성을 최소화하려면 override 매개변수를 사용합니다. 설정하고 true로 설정합니다.

API 프록시의 한 버전을 다른 버전 위에 배포할 수 없습니다. 첫 번째는 항상 있습니다 override를 true로 설정하면 버전이 1개임을 나타냅니다. 현재 배포된 버전을 통해 API 프록시의 인스턴스를 배포해야 합니다. 그 결과 배포 순서가 뒤집어져 새 버전이 배포되고 배포가 완료되면 완료되면 이미 배포된 버전의 배포가 취소됩니다.

다음 예에서는 override 값을 양식 매개변수로 전달하여 설정합니다.

curl -X POST -H "Content-type:application/x-www-form-urlencoded" \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/e/ENV_NAME/apis/API_NAME/revisions/REVISION_NUMBER/deployments" \
  -d "override=true" \
  -u EMAIL:PASSWORD

delay 매개변수를 설정하여 배포를 더욱 최적화할 수 있습니다. 이 delay 매개변수는 이전 배포를 취소해야 합니다 처리 중인 트랜잭션은 이 작업은 트랜잭션을 처리하는 API 프록시의 배포가 취소되기 전에 완료됩니다. 팔로우 중인 항목: override=true 및 delay 매개변수를 설정하면 다음과 같은 결과가 발생합니다.

버전 1은 요청을 처리합니다.
버전 2가 동시에 배포되고 있습니다.
버전 2가 완전히 배포되면 새 트래픽이 버전 2로 전송됩니다. 새 트래픽이 없습니다. 버전 1로 전송됩니다.
하지만 버전 1이 여전히 기존 트랜잭션을 처리하는 중일 수 있습니다. 먼저 delay 매개변수 (예: 15초)가 있는 경우 버전 1에 15초를 기존 트랜잭션 처리를 완료합니다
지연 간격이 지나면 버전 1이 배포 취소됩니다.

를 통해 개인정보처리방침을 정의할 수 있습니다.

참고: 재정의를 true로 설정하면 Apigee가 배포 취소되지 않습니다. 버전 1의 기본 경로가 버전 2의 기본 경로와 다른 경우 버전 1입니다. 이러한 시나리오에서 결국 동일한 환경에 두 개의 버전이 배포됩니다. 이로 인해 다른 플러그인이 이를 수용하지 않은 경우 원활한 배포 API를 활용하는 래퍼 및 래퍼를 어설션의 시나리오에 해당합니다.

curl -X POST -H "Content-type:application/x-www-form-urlencoded" \
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/e/ENV_NAME/apis/API_NAME/revisions/REVISION_NUMBER/deployments?delay=15" \
  -d "override=true" \
  -u EMAIL:PASSWORD

쿼리 매개변수 설명

쿼리 매개변수	설명
`override`	기본값은 `false`입니다 (일반 배포 동작: 기존 버전이 배포 취소되고 새 버전이 배포됨). 일반적인 배포 동작을 재정의하고 원활한 제공을 위해 `true`로 설정합니다. 배포할 수 있습니다 기존 버전이 배포된 상태로 유지되는 동안 새 버전도 배포됩니다. 배포할 수 있습니다 새 버전이 배포되면 이전 버전의 배포가 취소됩니다. 사용 위치 `delay` 매개변수와 함께 배포 취소 시기를 제어 발생합니다
`delay`	기존 버전에서 트랜잭션 처리가 완료될 수 있도록 허용하기 위해 배포 취소되어 `502 Bad Gateway` 또는 `504 Gateway Timeout errors` - 이 매개변수를 배포 취소할 시간(초)으로 설정합니다. 지연되고 있습니다. 설정할 수 있는 시간(초)에는 제한이 없으며, 성능 저하를 일으킬 수 있습니다. 지연 기간 동안에는 이전 버전으로 전송됩니다 기본값은 0초입니다. `override`가 true로 설정되어 있고 `delay`이 0이면 새 버전 직후 기존 버전의 배포가 취소됩니다. 배포할 수 있습니다 음수 값은 0초로 처리됩니다.

override

기본값은 false입니다 (일반 배포 동작: 기존 버전이 배포 취소되고 새 버전이 배포됨).

일반적인 배포 동작을 재정의하고 원활한 제공을 위해 true로 설정합니다. 배포할 수 있습니다 기존 버전이 배포된 상태로 유지되는 동안 새 버전도 배포됩니다. 배포할 수 있습니다 새 버전이 배포되면 이전 버전의 배포가 취소됩니다. 사용 위치 delay 매개변수와 함께 배포 취소 시기를 제어 발생합니다

delay

기존 버전에서 트랜잭션 처리가 완료될 수 있도록 허용하기 위해 배포 취소되어 502 Bad Gateway 또는 504 Gateway Timeout errors - 이 매개변수를 배포 취소할 시간(초)으로 설정합니다. 지연되고 있습니다. 설정할 수 있는 시간(초)에는 제한이 없으며, 성능 저하를 일으킬 수 있습니다. 지연 기간 동안에는 이전 버전으로 전송됩니다

기본값은 0초입니다. override가 true로 설정되어 있고 delay이 0이면 새 버전 직후 기존 버전의 배포가 취소됩니다. 배포할 수 있습니다 음수 값은 0초로 처리됩니다.

override=true가 delay와 함께 사용되는 경우 HTTP 5XX 제거할 수 있습니다. 이는 두 API 프록시 버전이 모두 지연 시간 후에는 이전 버전의 배포가 취소됩니다.

API의 모든 배포 보기 개정본

경우에 따라 현재 배포된 모든 API 버전의 목록을 가져와야 합니다. 사용할 수 있습니다

curl https://api.enterprise.apigee.com/v1/o/ORG_NAME/apis/weatherapi/revisions/1/deployments \
  -u EMAIL:PASSWORD

{
  "aPIProxy" : "weatherapi",
  "environment" : [ {
    "configuration" : {
      "basePath" : "",
      "steps" : [ ]
    },
    "name" : "test",
    "server" : [ {
      "status" : "deployed",
      "type" : [ "message-processor" ],
      "uUID" : "90096dd1-1019-406b-9f42-fbb80cd01200"
    }, {
      "status" : "deployed",
      "type" : [ "message-processor" ],
      "uUID" : "7d6e2eb1-581a-4db0-8045-20d9c3306549"
    }, {
      "status" : "deployed",
      "type" : [ "router" ],
      "uUID" : "1619e2d7-c822-45e0-9f97-63882fb6a805"
    }, {
      "status" : "deployed",
      "type" : [ "router" ],
      "uUID" : "8a5f3d5f-46f8-4e99-b4cc-955875c8a8c8"
    } ],
    "state" : "deployed"
  } ],
  "name" : "1",
  "organization" : "org_name"
}

위의 응답에는 Apigee의 내부 인프라와 관련된 여러 속성이 포함되어 있습니다. Edge. 온프레미스 Apigee Edge를 사용하지 않는 한 이 설정을 변경할 수 없습니다.

응답에 포함된 중요한 속성은 organization입니다. environment, aPIProxy, name, state 작성자: 이러한 속성 값을 검토하면 API 프록시의 특정 버전이 애플리케이션을 배포할 수 있습니다

다음에서 모든 배포 보기: 테스트 환경

또한 특정 환경 (버전 포함)의 배포 상태를 검색할 수도 있습니다. 다음 호출을 사용하여 현재 배포된 API 프록시의 수)합니다.

curl -u EMAIL:PASSWORD
  https://api.enterprise.apigee.com/v1/o/ORG_NAME/environments/test/deployments

이렇게 하면 테스트 환경에 배포된 모든 API에 대해 위와 동일한 결과가 반환됩니다.

다음에서 모든 배포 보기: 조직

모든 환경에 있는 모든 API 프록시의 현재 배포된 모든 버전 목록을 가져오려면 다음 안내를 따르세요. 다음 API 메서드를 사용합니다.

curl https://api.enterprise.apigee.com/v1/o/ORG_NAME/deployments \
  -u EMAIL:PASSWORD

그러면 모든 환경에 배포된 모든 API 프록시에 대해 위와 동일한 결과가 반환됩니다.

API는 RESTful이므로 POST 메서드를 JSON 또는 XML과 함께 사용하면 됩니다. 페이로드를 동일한 리소스에 대해 생성하여 API 프록시를 만듭니다.

API 프록시용 프로필이 생성됩니다. API 프록시의 기본 표현은 다음과 같습니다. JavaScript 객체 표기법 (JSON) 다음은 위의 POST 요청에 대한 기본 JSON 응답입니다. 이 명령어는 weatherapi라는 API 프록시를 만들었습니다. 프로필의 각 요소에 대한 설명 다음과 같습니다.

{
  "configurationVersion" : {
    "majorVersion" : 4,
    "minorVersion" : 0
  },
  "contextInfo" : "Revision 1 of application weatherapi, in organization {org_name}",
  "createdAt" : 1357172145444,
  "createdBy" : "you@yourcompany.com",
  "displayName" : "weatherapi",
  "lastModifiedAt" : 1357172145444,
  "lastModifiedBy" : "you@yourcompany.com",
  "name" : "weatherapi",
  "policies" : [ ],
  "proxyEndpoints" : [ ],
  "resources" : [ ],
  "revision" : "1",
  "targetEndpoints" : [ ],
  "targetServers" : [ ],
  "type" : "Application"
}

드림

생성되는 API 프록시 프로필은 API의 전체 구조를 보여줍니다. 프록시:

APIProxy revision: 순차적으로 번호가 매겨진 API 프록시의 반복입니다. API 서비스에서 유지관리하는 대로
APIProxy name: API 프록시의 고유한 이름입니다.
ConfigurationVersion: API 프록시가 적용되는 API 서비스 버전 구성을
CreatedAt: API 프록시가 생성된 시간으로, UNIX 시간 형식으로 지정됩니다.
CreatedBy: API를 만든 Apigee Edge 사용자의 이메일 주소입니다. 프록시
DisplayName: API 프록시의 사용자 친화적인 이름입니다.
LastModifiedAt: API 프록시가 생성된 시간이며 UNIX 형식으로 지정됩니다. 시간
LastModifiedBy: API를 만든 Apigee Edge 사용자의 이메일 주소입니다. 프록시
Policies: 이 API 프록시에 추가된 정책 목록입니다.
ProxyEndpoints: 이름이 지정된 ProxyEndpoint 목록
Resources: 다음을 사용할 수 있는 리소스 (JavaScript, Python, Java, XSLT) 이 API 프록시에서 실행되어야 합니다.
TargetServers: 이름이 지정된 TargetServers 목록 (다음을 사용하여 만들 수 있음) 관리 API)을 사용하여 부하 분산 목적으로 고급 구성에서 사용됩니다.
TargetEndpoints: 이름이 지정된 TargetEndpoint 목록입니다.

API 프록시 구성의 많은 요소는 간단한 POST를 사용하여 생성된 것입니다. 메서드가 비어 있습니다. 다음 주제에서는 키를 추가하고 구성하는 방법을 알아봅니다. API 프록시의 구성 요소입니다

API 프록시 구성 참조에서도 이러한 구성 요소에 대해 알아볼 수 있습니다.

API에 대한 스크립팅

샘플 API 프록시 사용, Apigee 배포 도구를 래핑하는 셸 스크립트를 제공합니다. 어떤 이유로든 발생한 경우 Python 배포 도구를 사용할 수 없다면 API를 직접 호출할 수 있습니다. 두 접근 방식 모두 샘플 스크립트에 나와 있습니다.

배포 도구 래핑

먼저 Python 배포 도구가 사용할 수 있습니다

그런 다음 사용자 인증 정보를 저장할 파일을 만듭니다. 작성하는 배포 스크립트는 이 설정을 사용하면 계정의 사용자 인증 정보를 중앙에서 관리할 수 있습니다. API 플랫폼 샘플. 이 파일의 이름은 setenv.sh입니다.

#!/bin/bash

org="Your ORG on enterprise.apigee.com"
username="Your USERNAME on enterprise.apigee.com"

# While testing, it's not necessary to change the setting below
env="test"
# Change the value below only if you have an on-premise deployment
url="https://api.enterprise.apigee.com"
# Change the value below only if you have a custom domain
api_domain="apigee.net"

export org=$org
export username=$username
export env=$env
export url=$url
export api_domain=$api_domain

위의 파일을 통해 배포를 래핑하는 셸 스크립트에서 모든 설정을 사용할 수 있습니다. 있습니다.

이제 이러한 설정을 가져오고 이를 사용하여 배포 도구를 호출하는 셸 스크립트를 만듭니다. 예를 보려면 <ph type="x-smartling-placeholder"></ph> Apigee API 플랫폼 샘플 참조)

#!/bin/bash

source path/to/setenv.sh

echo "Enter your password for the Apigee Enterprise organization $org, followed by [ENTER]:"

read -s password

echo Deploying $proxy to $env on $url using $username and $org

path/to/deploy.py -n {api_name} -u $username:$password -o $org -h $url -e $env -p / -d path/to/apiproxy

작업을 정말 쉽게 하기 위해 API를 호출하고 테스트하는 스크립트를 작성합니다. 다음과 같습니다.

#!/bin/bash

echo Using org and environment configured in /setup/setenv.sh

source /path/to/setenv.sh

set -x

curl "http://$org-$env.apigee.net/{api_basepath}"

API 직접 호출

데이터를 업로드하여 저장하는 프로세스를 자동화하는 간단한 셸 스크립트를 작성하면 API 프록시를 배포합니다

아래 스크립트는 관리 API를 직접 호출합니다. 기존 버전의 배포를 취소합니다. 업데이트할 API 프록시가 /apiproxy 디렉터리에서 ZIP 파일을 만듭니다. 설치한 다음, 웹 서버를 업로드, 가져오기 및 구성할 수 있습니다

#!/bin/bash

#This sets the name of the API proxy and the basepath where the API will be available
api=api

source /path/to/setenv.sh

echo Delete the DS_store file on OSX

echo find . -name .DS_Store -print0 | xargs -0 rm -rf
find . -name .DS_Store -print0 | xargs -0 rm -rf

echo "Enter your password for the Apigee Enterprise organization $org, followed by [ENTER]:"

read -s password

echo Undeploy and delete the previous revision

# Note that you need to explicitly update the revision to be undeployed.
# One benefit of the Python deploy tool is that it manages this for you.

curl -k -u $username:$password "$url/v1/o/$org/e/$env/apis/$api/revisions/1/deployments" -X DELETE

curl -k -u $username:$password -X DELETE "$url/v1/o/$org/apis/$api/revisions/1"

rm -rf $api.zip

echo Create the API proxy bundle and deploy

zip -r $api.zip apiproxy

echo Import the new revision to $env environment 

curl -k -v -u $username:$password "$url/v1/o/$org/apis?action=import&name=$api" -T $api.zip -H "Content-Type: application/octet-stream" -X POST

echo Deploy the new revision to $env environment 

curl -k -u $username:$password "$url/v1/o/$org/e/$env/apis/$api/revisions/1/deployments" -X POST