간단한 API 프록시 빌드

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

Apigee Edge 문서 보기

Apigee를 사용하면 백엔드 서비스를 API로 빠르게 노출할 수 있습니다. 이렇게 하려면 노출하려는 백엔드 서비스의 퍼사드를 제공하는 API 프록시를 만듭니다. 백엔드 서비스의 네트워크 주소만 제공하고 개발자에게 노출되는 API 프록시를 만드는 데 Apigee가 사용하는 일부 정보를 제공해야 합니다.

API 프록시는 개발자가 사용하는 API에서 백엔드 서비스 구현을 분리합니다. 이렇게 하면 개발자가 향후 백엔드 서비스를 변경하는 것을 방지할 수 있습니다. 백엔드 서비스를 업데이트할 때 개발자는 이러한 변경사항에서 격리되어 API를 중단 없이 계속 호출할 수 있습니다.

이 주제에서는 여러 프록시 유형과 이에 대한 설정에 대한 정보를 제공합니다. 프록시 만들기에 대한 단계별 안내는 다음 항목을 참조하세요.

• 튜토리얼: 첫 번째 API 프록시 빌드
• API 프록시 만들기

UI를 사용하여 API 프록시 만들기

API 프록시를 만드는 가장 쉬운 방법은 프록시 만들기 마법사를 사용하는 것입니다.

프록시 만들기 마법사는 API 프록시에 최소한의 기능을 생성하고 추가하는 단계를 보여주고 안내합니다.

마법사의 첫 번째 페이지를 통해 다음 소스로부터 API 프록시를 만들 수 있습니다.

다음 섹션에서는 각 프록시 유형을 자세히 다룹니다.

HTTP 서비스용 역방향 프록시 만들기

Apigee는 다음 정보를 기준으로 역방향 프록시를 생성합니다.

• 백엔드 서비스의 URL
• API 프록시에서 소비자 앱에 노출되는 API를 고유하게 식별하는 URI 경로입니다.

백엔드 서비스 URL은 일반적으로 조직에서 소유한 서비스 사용 설정 애플리케이션을 나타냅니다. 공개적으로 사용 가능한 API를 가리킬 수도 있습니다. API 또는 서비스는 제어할 수 있거나(예: 내부 HR 애플리케이션 또는 Cloud의 Rails 애플리케이션) 타사 API 또는 서비스(예: Twitter 또는 Instagram)일 수 있습니다.

다음 프록시 세부정보는 프록시 만들기 마법사에 액세스하여 프록시 유형을 선택한 후에 사용할 수 있습니다.

API 프록시 번들에서 API 프록시 가져오기

종종 API 프록시를 다른 지원 파일과 함께XML 파일의 컬렉션으로 정의합니다. API 프록시를 Apigee 외부의 파일 집합으로 정의하면 소스 제어 시스템에서 유지관리한 후 테스트 및 배포를 위해 Apigee로 가져올 수 있습니다.

API 프록시 번들에서 API 프록시를 가져오려면 다음 단계를 수행합니다.

1. UI를 사용하여 API 프록시 만들기에 설명된 대로 프록시 만들기 마법사에 액세스합니다.
2. API 프록시 번들 세부정보를 지정합니다.

Cloud 콘솔의 Apigee UI

1. 프록시 템플릿 메뉴에서 프록시 번들 업로드를 선택합니다.
2. 프록시 세부정보 섹션에서 프록시 이름을 입력하고 ZIP 파일을 업로드한 후 다음을 클릭합니다.
3. 배포 섹션에서 배포 환경을 선택하고, 원하는 경우 만들기를 클릭합니다.

기본 UI

1. 프록시 번들 업로드를 클릭합니다.

2. 프록시 마법사의 프록시 번들 업로드 페이지에서 다음 정보를 입력합니다.

   필드	설명
   ZIP 번들	API 프록시 구성이 포함된 ZIP 파일입니다. 드래그 앤 드롭하거나 클릭하여 파일로 이동합니다.
   이름	API에 표시되는 이름입니다. 확장자를 제외한 ZIP 파일 이름을 기본값으로 사용합니다.

3. 다음을 클릭합니다.

4. 요약 페이지에서 배포 환경을 선택하고 원하는 경우 만들기 및 배포를 클릭합니다.

   새 API 프록시가 성공적으로 생성되었음을 보여주는 확인이 표시됩니다.

5. 프록시 수정을 클릭하여 API 프록시의 세부정보 페이지를 표시합니다.

gRPC API 프록시 만들기

현재 Apigee gRPC API 프록시는 다음과 같은 특성을 갖습니다.

• 단항 gRPC 요청을 지원합니다.
• 페이로드에 영향을 주는 정책을 사용할 수 없습니다.
• GraphQL 또는 REST 프록시와 연결되지 않은 API 제품에서 사용할 수 있습니다. API 제품 관련 할당량 및 기타 작업 설정이 제품의 모든 프록시에 적용됩니다.
• Apigee Hybrid에서는 지원되지 않습니다.
• 두 가지 gRPC 관련 흐름 변수인 request.grpc.rpc.name과 request.grpc.service.name이 사용됩니다.
• gRPC와 관련된 Apigee 애널리틱스 변수인 x_apigee_grpc_rpc_name, x_apigee_grpc_service_name, x_apigee_grpc_status을 사용하여 모니터링할 수 있습니다.
• gRPC 상태 코드를 반환합니다.

또한 gRPC를 지원하도록 부하 분산기를 구성해야 합니다. 애플리케이션에 gRPC 사용 및 gcloud CLI 명령어를 사용하여 gRPC에 대한 라우팅 만들기를 참조하세요.

gRPC API 프록시를 만들려면 먼저 gRPC 대상 서버를 정의하고(대상 서버 만들기 참조) 새 프록시를 만들 때 대상 서버를 지정합니다.

gcloud CLI 명령어를 사용하여 gRPC에 대한 라우팅 만들기

이 섹션에서는 gcloud CLI를 사용해서 gRPC 프록시에 대해 라우팅을 만들기 위한 명령어 예시를 보여줍니다. 여기에는 부하 분산기, 대상 서버, MIG 설정이 포함됩니다.

이 섹션은 라우팅 만들기에 대한 포괄적인 가이드가 아닙니다. 이러한 예시는 일부 사용 사례에 따라 적합하지 않을 수 있습니다. 또한 여기에서는 사용자가 외부 라우팅(MIG) 및 Cloud 부하 분산기 gRPC 구성에 익숙하다고 가정합니다.

환경 변수 설정하기

이러한 환경 변수는 하위 섹션의 명령어에 사용됩니다.

PROJECT_ID=YOUR_PROJECT_ID
MIG_NAME=YOUR_MIG_NAME
VPC_NAME=default
VPC_SUBNET=default
REGION=REGION_NAME
APIGEE_ENDPOINT=ENDPOINT
CERTIFICATE_NAME=CERTIFICATE_NAME
DOMAIN_HOSTNAME=DOMAIN_HOSTNAME

gcloud compute instance-templates create $MIG_NAME \
--project $PROJECT_ID \
--region $REGION \
--network $VPC_NAME \
--subnet $VPC_SUBNET \
--tags=https-server,apigee-mig-proxy,gke-apigee-proxy \
--machine-type e2-medium --image-family debian-12 \
--image-project debian-cloud --boot-disk-size 20GB \
--no-address \
--metadata ENDPOINT=$APIGEE_ENDPOINT,startup-script-url=gs://apigee-5g-saas/apigee-envoy-proxy-release/latest/conf/startup-script.sh

gcloud compute instance-groups managed create $MIG_NAME \
--project $PROJECT_ID --base-instance-name apigee-mig \
--size 2 --template $MIG_NAME --region $REGION

gcloud compute instance-groups managed set-autoscaling $MIG_NAME \
--project $PROJECT_ID --region $REGION --max-num-replicas 50 \
--target-cpu-utilization 0.75 --cool-down-period 90

gcloud compute instance-groups managed set-named-ports $MIG_NAME \
--project $PROJECT_ID --region $REGION --named-ports https:443

gcloud compute ssl-certificates create $CERTIFICATE_NAME \
--domains=$DOMAIN_HOSTNAME \
--project $PROJECT_ID \
--global

gcloud compute ssl-certificates describe $CERTIFICATE_NAME \
--global \
--format="get(name,managed.status, managed.Status)"

gcloud compute target-https-proxies create apigee-envoy-https-proxy \
--project $PROJECT_ID --url-map apigee-envoy-proxy-map \
--ssl-certificates $CERTIFICATE_NAME

gcloud compute addresses create lb-ipv4-vip-1 \
--project $PROJECT_ID \
--network-tier=PREMIUM \
--ip-version=IPV4 \
--global

  gcloud compute addresses describe lb-ipv4-vip-1 \
--project $PROJECT_ID --format="get(address)" --global

  gcloud compute forwarding-rules create apigee-envoy-https-lb-rule \
--project $PROJECT_ID --address lb-ipv4-vip-1 --global \
--target-https-proxy apigee-envoy-https-proxy --ports 443

gcloud compute firewall-rules create k8s-allow-lb-to-apigee-envoy \
--description "Allow incoming from GLB on TCP port 443 to Apigee Proxy" \
--project $PROJECT_ID --network $VPC_NAME --allow=tcp:443 \
--source-ranges=130.211.0.0/22,35.191.0.0/16 --target-tags=gke-apigee-proxy

# Create backend service for http2
    gcloud compute backend-services create YOUR_BACKEND_2 \
--project $PROJECT_ID \
--protocol HTTP2 \
--health-checks hc-apigee-envoy-443 \
--port-name https \
--timeout 302s \
--connection-draining-timeout 300s \
--global

gcloud compute backend-services add-backend YOUR_BACKEND_2 \
--project $PROJECT_ID --instance-group $MIG_NAME \
--instance-group-region $REGION \
--balancing-mode UTILIZATION --max-utilization 0.8 --global

gcloud compute url-maps list -project $PROJECT_ID

gcloud compute url-maps export APIGEE_URL_MAP_NAME -project $PROJECT_ID

defaultService: projects/dg-runtime-test1/global/backendServices/YOUR_BACKEND_1
name: matcher1
routeRules:
- matchRules:
- headerMatches:
- headerName: Content-Type
prefixMatch: application/grpc
prefixMatch: /
priority: 100
routeAction:
weightedBackendServices:
- backendService: projects/dg-runtime-test1/global/backendServices/YOUR_BACKEND_2
weight: 100

gcloud compute url-maps import APIGEE_URL_MAP_NAME\
--source /tmp/apigee-map.yaml  \
--global -project $PROJECT_ID

보안 추가

프록시 보안은 프록시에 정책을 추가하여 구현됩니다. 정책에 대한 자세한 내용은 정책이란 무엇인가요?를 참고하세요. 보안에 관한 자세한 내용은 프록시 보안을 참고하세요.

프록시에 보안 정책을 추가하려면 다음 단계를 따르세요.

CORS 지원 추가

교차 출처 리소스 공유(CORS)는 웹브라우저가 다른 도메인에 직접 요청을 수행할 수 있도록 허용하는 표준 메커니즘입니다. CORS 표준은 웹브라우저와 서버가 교차 도메인 통신을 구현하는 데 사용하는 HTTP 헤더 집합을 정의합니다.

ProxyEndpoint의 요청 PreFlow에 CORS 정책을 추가하여 CORS 지원을 추가할 수 있습니다.

CORS 시행 전 지원 추가 등을 포함한 CORS 지원에 대한 자세한 정보는 API 프록시에 CORS 지원 추가하기를 참고하세요.

할당량 추가

할당량 아래의 높은 트래픽으로부터 백엔드 서비스를 보호하기 위한 할당량입니다. 할당량 부분을 참고하세요. (패스 스루 승인을 선택한 경우에는 사용할 수 없습니다.)

OpenAPI 사양을 사용하여 프록시 생성

이 섹션에서는 OpenAPI 사양에서 역방향 또는 대상 없음과 같은 유형의 API 프록시를 생성하기 위해 사용할 수 있는 OpenAPI 사용 옵션을 설명합니다.

OpenAPI 사양이란 무엇인가요?

   'Open API Initiative(OAI)는 Swagger 사양에 따라 공급업체 중립적 API 설명 형식을 생성, 발전, 승격하는 데 중점을 두고 있습니다.' 자세한 내용은 OpenAPI Initiative를 참조하세요.

OpenAPI 사양에서는 표준 형식을 사용하여 RESTful API를 설명합니다. JSON 또는 YAML 형식으로 작성된 OpenAPI 사양은 머신이 읽을 수 있지만 사람도 쉽게 읽고 이해할 수 있습니다. 사양은 기본 경로, 경로 및 동사, 헤더, 쿼리 매개변수, 작업, 콘텐츠 유형, 응답 설명 등과 같은 API 요소를 설명합니다. 또한 OpenAPI 사양은 일반적으로 API 문서를 생성하는 데 사용됩니다.

OpenAPI 사양의 다음 프래그먼트는 Apigee의 모의 대상 서비스인 http://mocktarget.apigee.net을 설명합니다. 자세한 내용은 helloworld 샘플에 대한 OpenAPI 사양을 참조하세요.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...

프록시 만들기 마법사를 통해 OpenAPI 사양을 가져오고 이를 사용하여 API 프록시를 생성할 수 있습니다. 프록시가 생성되면 모든 Apigee 프록시처럼 Apigee UI를 사용하여 정책을 추가하고, 커스텀 코드를 구현하는 등의 작업을 통하여 개발할 수 있습니다.

OpenAPI 사양에서 API 프록시 만들기

OpenAPI 사양에서 API 프록시를 만듭니다. 몇 번의 클릭만으로 경로, 매개변수, 조건부 흐름, 대상 엔드포인트가 자동으로 생성된 API 프록시를 갖게 됩니다. 그런 다음 OAuth 보안, 비율 제한, 캐싱과 같은 기능을 추가할 수 있습니다.

프록시 만들기 마법사에서 OpenAPI 사양 사용을 클릭하고 마법사의 지시에 따라 OpenAPI 사양에서 역방향 프록시나 대상 없는 프록시를 만듭니다. 자세한 내용은 OpenAPI 사양에서 API 프록시 만들기를 참조하세요.

API 프록시의 새 버전 만들기

API 프록시의 새 버전을 만들려면 다음 단계를 수행하세요.

1. Apigee UI를 엽니다.

Cloud 콘솔의 Apigee

Google Cloud 콘솔에서 프록시 개발 > API 프록시 페이지로 이동합니다.

API 프록시로 이동

기본 Apigee UI

1. Apigee UI에 로그인합니다.
2. 탐색 메뉴에서 개발 > API 프록시를 선택합니다.
2. 복사하려는 목록에서 API 프록시를 클릭합니다.

3. 개발 탭을 클릭합니다.

4. 저장 버튼을 선택하고 새 버전으로 저장을 선택합니다.

API 프록시 백업

API 프록시 번들에 기존 API 프록시를 XML 파일 집합으로 백업할 수 있습니다. 번들에 내보낸 후에는 이 섹션 앞부분의 API 프록시 번들에서 API 프록시 가져오기에 설명된 대로 API 프록시를 새 프록시로 가져올 수 있습니다. 자세한 내용은 API 프록시 다운로드를 참고하세요.

API를 사용하여 API 프록시 만들기

API를 사용하여 API 프록시를 만들려면 API 프록시 만들기를 참조하세요.

대상 프록시 없음 정보

요청을 백엔드 서비스로 전달하지 않고 Apigee 자체 내에서 처리하려는 경우 Apigee의 대상 없음 프록시가 유용합니다. 이 방식이 적절한 경우를 이해해야 합니다.

일반 사용 사례

• Apigee 관리 데이터와 상호작용: 키-값 맵(KVM) 또는 Apigee 캐시에 저장된 데이터와 같이 Apigee 관리 데이터와만 상호작용해야 하는 경우에는 대상 없음 프록시가 유용합니다. 예를 들어 대상 없음 프록시를 사용하여 KVM에서 사용자 세션 데이터 또는 구성 데이터와 같은 데이터를 검색할 수 있습니다. 이 경우 백엔드 서비스를 호출할 필요가 없습니다. 프록시 흐름에 KeyValueMapOperations 정책만 있으면 됩니다. 또 다른 예시로, 캐시가 플러시되도록 발신자가 요청할 수 있습니다. 대상에 연결할 필요 없이 InvalidateCache 정책을 호출하여 이 작업을 수행할 수 있습니다.
• 모의 API 사용: 백엔드 구현이 완료되기 전에 모의 API를 만들어 API 동작을 시뮬레이션해 프런트엔드 개발이 독립적으로 진행되도록 할 수 있습니다. 모의 API 만드는 방법에 대한 자세한 내용은 OpenAPI 모의 API 프록시를 참조하세요.
• 토큰 관리: Apigee는 OAuthV2 토큰을 발급할 수 있으며 이는 일반적으로 대상 없음 프록시를 통해 수행됩니다.
• 정책 동작 테스트: Apigee 정책을 사용하여 동작을 테스트하려는 경우에 대상 없음 프록시가 유용할 수 있습니다.