재사용 가능한 공유 흐름 만들기

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

Apigee Edge 문서 보기

정책과 리소스를 여러 API 프록시, 그리고 다른 공유 흐름에서도 사용할 수 있는 공유 흐름으로 결합합니다. 프록시와 비슷하지만 공유 흐름에는 엔드포인트가 없습니다. 공유 흐름과 같은 조직에 속한 API 프록시 또는 공유 흐름에서만 사용할 수 있습니다.

공유 흐름은 여러 위치에서 유용한 한 장소 기능에서 캡처함으로써 일관성을 보장하고 개발 시간을 단축하며 코드를 더 쉽게 관리할 수 있도록 합니다.

다음 동영상은 Apigee UI에서 공유 흐름을 만들고 디버깅하는 방법을 보여줍니다.

FlowCallout 정책을 사용하여 공유 흐름을 호출할 수 있습니다. 또한 공유 흐름을 흐름 후크에 연결하면 프록시 또는 대상 요청 전이나 프록시 또는 대상 응답 후에 공유 흐름을 실행할 수 있습니다.

FlowCallout 정책에 대한 자세한 내용은 FlowCallout 정책을 참조하세요. 흐름 후크에 대한 자세한 내용은 흐름 후크를 사용하여 공유 흐름 연결을 참조하세요.

예를 들어 여러 위치에서 사용되거나 조직의 API 전반에서 표준화되어야 하는 기능 영역이 있다고 가정해 봅시다. 다음을 포함하여 각 카테고리에 대한 공유 흐름을 만들 수 있습니다.

  • 보안은 OAuth를 사용하는 승인 코드 및 API 키 인증뿐만 아니라 위협 보호 조치 코드로 적용됩니다.
  • 로깅은 표준 오류 메시지를 생성하기 위한 것입니다.
  • 미디에이션은 XML 및 JSON 메시지 형식 간의 변환을 위한 것입니다.

다음 이미지에서 두 개의 API 프록시는 들어오는 사용자 요청을 인증하기 위해 FlowCallout 정책이 있는 공유 흐름을 호출합니다. AuthSharedFlow는 프록시의 요청을 지원할 수 있도록 프록시 이전에 조직에 별도로 배포되었습니다. 공유 흐름은 광범위한 회사 정책을 담당하는 팀에서 개발하고 관리할 수 있으며, 더 전문화된 앱을 빌드하는 비즈니스 계열 팀 프록시에서 사용할 수 있습니다.

POST/foodcarts 정책에서 AuthSharedFlow에 대한 POST/menus 정책을 보여주는 흐름도.


          콜아웃 텍스트:
a) 여러 API 프록시가 FlowCallout을 통해 공유 흐름을 사용합니다.
          b) FlowCallout 정책은 API 프록시에서 공유 흐름을 호출합니다.
          c) 공유 흐름 번들에는 정책 및 리소스로 재사용 가능한 로직이 포함됩니다.

공유 흐름 개발

공유 흐름을 개발할 때는 항상 API 프록시로 전송된 호출을 사용하여 테스트해야 합니다. 즉, API 프록시와 마찬가지로 공유 흐름으로 직접 요청을 보낼 수 없습니다. 대신 API 프록시로 요청을 보내면 이는 공유 흐름을 호출합니다.

다음은 공유 흐름을 개발하기 위한 대략적인 단계입니다.

  1. 공유 기능 집합에 대해 알아보세요.

    예를 들어 트래픽 급증 억제를 포함한 트래픽 관리 기능을 결합할 수 있습니다. 이렇게 하면 비즈니스 계열 로직을 구현하는 워크플로 이외의 구성을 관리할 수 있습니다.

  2. API 프록시를 개발할 때와 마찬가지로 정책을 구현하고 리소스를 지원하여 공유 흐름을 개발합니다.

    공유 흐름은 일련의 조건부 단계입니다. 따라서 하나를 개발하는 것이 API 프록시를 개발하는 것과 같습니다. 프록시에 포함할 수 있는 정책 및 리소스를 포함할 수 있습니다.

    예를 들어 트래픽 관리 지원 일환으로 다음 예시와 같이 Spike Arrest 정책을 구현하여 초당 30개의 요청만 허용할 수 있습니다.

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
        <DisplayName>Spike Arrest</DisplayName>
        <Properties/>
        <Identifier ref="request.header.some-header-name"/>
        <MessageWeight ref="request.header.weight"/>
        <Rate>30ps</Rate>
    </SpikeArrest>

    그런 다음 트래픽 관리를 위한 공유 흐름에 급증 저지 정책을 단계로 연결할 수 있습니다. 이 정책은 공유 흐름을 호출하는 모든 API 프록시에 대해 실행됩니다.

    <SharedFlow name="default">
        <Step>
            <Name>Spike-Arrest</Name>
        </Step>
    </SharedFlow>

    관리 콘솔에서 공유 흐름을 시작하는 방법에 대한 자세한 내용은 Apigee UI에서 공유 흐름 만들기를 참조하세요.

    API 프록시와 마찬가지로 공유 흐름 API 만들기를 사용하여 공유 흐름 소스 아티팩트가 포함된 ZIP 파일을 가져올 수 있습니다. 다음은 Apigee API를 사용하여 공유 흐름을 가져오는 방법을 보여줍니다.

    curl "https://apigee.googleapis.com/v1/organizations/$ORG/sharedflows?action=import&sharedFlowID=mySharedFlow" \
      -X POST \
      -F "file=@sharedflow.zip" \
      -H "Authorization: Bearer $TOKEN"

    $TOKENOAuth 2.0 액세스 토큰 가져오기에 설명된 대로 OAuth 2.0 액세스 토큰으로 설정합니다. 이 예시에서 사용된 curl 옵션에 대한 자세한 내용은 curl 사용을 참조하세요. 사용된 환경 변수에 대한 설명은 Apigee API 요청에 대한 환경 변수 설정을 참조하세요.

  3. 이를 사용할 프록시 또는 공유 흐름을 배포하기 전에 환경에 공유 흐름을 배포합니다. API 프록시를 배포하는 것과 동일한 방식으로 공유 흐름을 배포합니다. 자세한 내용은 배포 개요를 참조하세요.

    공유 흐름은 동일한 조직에 있어야 하며 API 프록시 및 이를 사용하는 다른 공유 흐름과 동일한 환경에 배포되어야 합니다. 프록시 전에 공유 흐름을 배포하면 배포 시간에 공유 흐름에서 프록시의 종속 항목을 결정할 수 있습니다.

    다음과 같은 Apigee API 호출로 공유 흐름을 배포할 수 있습니다.

    curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/sharedflows/$SHAREDFLOW/revisions/$REV/deployments \
      -X POST \
      -H "Authorization: Bearer $TOKEN"

    API 프록시와 마찬가지로 Apigee에 대한 모든 성공적인 공유 흐름 배포는 다운타임 없는 배포입니다.

  4. 자체 흐름의 일부로 공유 흐름을 호출할 수 있도록 사용 중인 API 프록시를 개발합니다.

    API 프록시에서 FlowCallout 정책을 사용하여 공유 흐름을 호출합니다. 흐름 후크를 사용하여 공유 흐름을 프록시에 연결할 수도 있습니다.

    공유 흐름을 사용하려면 이를 사용할 프록시 또는 이를 공유 흐름에 FlowCallout 정책을 추가합니다. 다른 서비스를 호출하는 서비스 콜아웃 정책과 마찬가지로 FlowCallout은 공유 흐름을 호출합니다. 사용 중인 API 프록시는 공유 흐름 이후 및 공유 흐름과 동일한 환경에 배포해야 합니다. FlowCallout 정책을 사용하여 호출을 테스트하려는 경우 공유 흐름이 있어야 합니다.

    다음 코드에서 FlowCallout 정책은 traffic-management-shared라는 공유 흐름을 호출합니다.

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
        <DisplayName>Traffic Management FlowCallout</DisplayName>
        <Properties/>
        <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
    </FlowCallout>

    자세한 내용은 API 프록시 또는 공유 흐름에서 공유 흐름 호출을 참조하세요.

  5. 사용 중인 API 프록시를 배포하여 공유 흐름을 사용해 보세요. (일반적인 배포에 대한 자세한 내용은 배포 개요를 참조하세요.)
  6. API 프록시를 사용할 때와 마찬가지로 추적을 통해 반복적으로 개발합니다.

    API 프록시와 마찬가지로 원하는 로직을 얻을 때까지 반복적으로 호출 및 추적하여 공유 흐름을 개발합니다. 이 경우 공유 흐름이 그 자체로 실행되지 않기 때문에 프록시 엔드포인트를 호출하고 프록시를 디버그합니다.

    이를 수행하는 절차는 다음과 같습니다.

    1. FlowCallout 정책을 사용하여 이를 호출하는 API 프록시와 공유 흐름 모두 동일한 조직에 있고 동일한 환경에 배포되었는지 확인합니다.
    2. API 프록시의 Trace 탭에서 API 프록시 trace를 시작합니다.
    3. API 프록시에서 프록시 엔드포인트로 요청을 보냅니다. 엔드포인트의 흐름에는 공유 흐름을 호출하는 FlowCallout 정책이 포함되어야 합니다.
    4. Trace 탭에서 API 프록시에서 공유 흐름으로의 흐름을 평가합니다.

      추적 시 공유 흐름은 회색 상자로 둘러싸인 단계 또는 정책의 집합으로 표현됩니다. FlowCallout 정책을 나타내는 아이콘이 공유 흐름보다 우선합니다. 디버그에 대한 자세한 내용은 디버그 도구를 참조하세요.

      트랜잭션 지도  콜아웃 텍스트:
a) FlowCallout 정책이 공유 흐름을 호출합니다.
            b) 공유 흐름에는 SpokeArrest 정책 및 FlowCallout 정책이 포함됩니다.
            FlowCallout 정책은 VerifyAPIKey 정책으로 다른 공유 흐름을 호출합니다.

Apigee UI에서 공유 흐름 만들기

Apigee API를 사용하여 공유 흐름을 만들 때 처음부터 새로 만들거나 기존 흐름 소스를 흐름 번들 ZIP 파일로 가져올 수 있습니다.

아래 설명에 따라 공유 흐름 페이지에 액세스합니다. 공유 흐름 페이지에서 조직의 공유 흐름 목록을 확인하고 목록에서 흐름을 수정하거나 삭제할 수 있습니다.

Apigee UI에서 공유 흐름을 만들려면 다음 안내를 따르세요.

  1. Apigee UI에 로그인합니다.
  2. 공유 흐름을 포함하는 조직을 선택합니다. 조직 간 전환을 참조하세요.

    공유 흐름은 이 조직의 환경에 배포된 모든 API 프록시 및 공유 흐름에 사용할 수 있습니다. 이 조직 외부에서 사용할 수 없습니다.

  3. 왼쪽 탐색 메뉴에서 개발 > 공유 흐름을 선택합니다.
  4. 공유 흐름을 만들거나 업로드합니다.
    • 새로 만들기를 클릭하여 처음부터 새 흐름을 만듭니다. 흐름의 단계로 정책 및 리소스를 구성할 수 있습니다.

      공유 흐름 만들기 대화상자가 표시됩니다.

      1. 공유 흐름의 이름을 입력합니다.

        이는 API 프록시 및 기타 공유 흐름에서 이 공유 흐름을 참조하는 데 사용하는 이름입니다. 이름은 흐름을 사용하는 개발자에게 설명할 수 있어야 합니다.

      2. 흐름이 하는 일에 대한 자세한 정보를 제공하기 위한 설명을 입력합니다.
      3. 만들기를 클릭합니다.

        공유 흐름이 생성됩니다.

      4. 그런 다음 공유 흐름 기능을 개발하고 원하는 환경에 배포할 수 있습니다.
    • 흐름 번들을 업로드하여 기존 소스에서 공유 흐름을 만들려면 번들 업로드를 클릭합니다.

      공유 흐름 번들에는 공유 흐름의 소스 아티팩트가 포함됩니다. 예를 들어 Apigee UI에서 공유 흐름을 다운로드하는 경우 흐름 번들이 포함된 ZIP 파일을 갖게 됩니다.

      공유 흐름 만들기 대화상자가 표시됩니다.

      1. 새 흐름에서 원하는 아티팩트가 포함된 ZIP 파일을 선택합니다.
      2. 열기를 클릭합니다.
      3. 가져온 공유 흐름의 이름을 입력합니다.

        이는 API 프록시 및 기타 공유 흐름에서 이 공유 흐름을 참조하는 데 사용하는 이름입니다. 이름은 흐름을 사용하는 개발자에게 설명할 수 있어야 합니다.

      4. 만들기를 클릭합니다.

        공유 흐름은 번들에서 생성됩니다.

      5. 그런 다음 공유 흐름 기능을 개발하고 원하는 환경에 배포할 수 있습니다.

API 프록시 또는 공유 흐름에서 공유 흐름 호출

FlowCallout 정책을 사용하여 프록시 또는 다른 공유 흐름에서 공유 흐름을 호출할 수 있습니다.

  1. Apigee UI에서 공유 흐름을 호출하려는 API 프록시 또는 공유 흐름을 엽니다.
  2. 개발 탭을 클릭합니다.
  3. 탐색기에서 정책 옆에 있는 +를 클릭합니다.
  4. 정책 목록의 확장 프로그램에서 FlowCallout을 클릭합니다.
  5. 표시 이름과 이름(고유 식별자)을 입력한 다음 이 정책에서 호출할 공유 흐름을 선택합니다.
  6. 추가를 클릭합니다.
  7. 호출을 수행할 프록시에 새 FlowCallout 정책을 추가합니다.

추가 정보

API 프록시 체이닝