Creazione di un proxy API semplice

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Nota: negli ambienti in cui sono abilitati i deployment di archiviazione, non puoi creare proxy API utilizzando l'interfaccia utente, l'API o gcloud di Apigee. Per creare proxy API per i deployment di archiviazione utilizzando Apigee in VS Code,consulta Sviluppo di proxy API utilizzando Apigee in VS Code.

Apigee ti consente di esporre rapidamente i servizi di backend come API. Per farlo, crea un proxy API che fornisca un'interfaccia per il servizio di backend che vuoi esporre. Devi fornire solo l'indirizzo di rete per il servizio di backend, insieme ad alcune informazioni che Apigee utilizza per creare il proxy API esposto agli sviluppatori.

Il proxy API disaccoppia l'implementazione del servizio di backend dall'API utilizzata dagli sviluppatori. Questo protegge gli sviluppatori dalle modifiche future ai servizi di backend. Man mano che aggiorni i servizi di backend, gli sviluppatori, isolati da queste modifiche, possono continuare a chiamare l'API senza interruzioni.

Questo argomento fornisce informazioni sui vari tipi di proxy e sulle relative impostazioni. Per istruzioni dettagliate sulla creazione dei proxy, consulta i seguenti argomenti:

• Tutorial: Crea il tuo primo proxy API
• Creazione di un proxy API

Nota: il seguente video mostra il proxy Editor classico nell'interfaccia utente di Apigee. Apigee sta introducendo una nuova versione dell'Editor proxy, che ha un design diverso dalla versione classica mostrata nel video.

Creazione di un proxy API mediante l'interfaccia utente

Il modo più semplice per creare un proxy API è utilizzare la procedura guidata Crea proxy.

Per accedere alla procedura guidata Crea proxy utilizzando l'interfaccia utente di Apigee, segui questi passaggi:

1. Accedi all'interfaccia utente di Apigee.
2. Nella barra di navigazione, seleziona Sviluppo > Proxy API.
3. Fai clic su Crea nuovo.
   

La procedura guidata Crea proxy mostra e guida i passaggi per generare e aggiungere funzionalità minime a un proxy API.

La prima pagina della procedura guidata consente di creare un proxy API dalle seguenti origini:

Tipo	Descrizione
Proxy inverso (più comune)	Un proxy API che indirizza le richieste in entrata ai servizi di backend HTTP esistenti. Può essere un'API JSON o XML. Consulta Creazione di un proxy inverso per un servizio HTTP più avanti in questa sezione. Fai clic su Usa specifica OpenAPI per generare il proxy da una specifica OpenAPI valida. Per ulteriori informazioni su questa opzione, consulta Utilizzo delle specifiche OpenAPI per generare proxy più avanti in questa sezione.
Nessun target	Un proxy API senza backend API ("nessuna destinazione"). Come per la creazione di un proxy inverso per un servizio HTTP descritta in precedenza, l'unica differenza che devi specificare un'API esistente è che devi definire i dettagli del proxy API. Fai clic su Utilizza specifica OpenAPI per generare il proxy da una specifica OpenAPI valida. Per ulteriori informazioni su questa opzione, consulta Utilizzo delle specifiche OpenAPI per generare proxy più avanti in questa sezione.
Carica bundle proxy	Un bundle di proxy API esistente (ad esempio uno dei proxy API di esempio disponibili su GitHub). Consulta la pagina Importazione di un proxy API da un bundle proxy API.

Le sezioni seguenti discutono i dettagli di ciascun tipo di proxy.

Creazione di un proxy inverso per un servizio HTTP

Apigee genera proxy inversi in base alle seguenti informazioni:

• URL del servizio di backend.
• Percorso URI che identifica in modo univoco l'API che verrà esposta dal proxy API alle app consumer.

L'URL del servizio di backend in genere rappresenta un'applicazione abilitata per il servizio di proprietà della tua organizzazione. Può anche puntare a un'API disponibile pubblicamente. L'API o il servizio può essere sotto il tuo controllo (ad esempio, un'applicazione RU interna o un'applicazione Rails nel cloud) oppure può essere un'API o un servizio di terze parti (ad esempio, Twitter o Instagram).

I seguenti dettagli del proxy sono disponibili dopo aver eseguito l'accesso alla creazione guidata del proxy e aver selezionato un tipo di proxy:

Campo	Descrizione
Nome	Nome visualizzato per l'API. Specifica caratteri alfanumerici, trattini (-) o trattini bassi (_).
Percorso di base	Frammento URI visualizzato dopo l'indirizzo http://[host] o https://[host] del proxy API. Apigee utilizza l'URI del percorso di base per associare e instradare i messaggi di richiesta in entrata al proxy API corretto. Nota: per impostazione predefinita, il percorso di base del proxy API utilizzerà il valore specificato per il campo Name convertito in lettere minuscole. Nel percorso di base sono presenti eventuali URL di risorse aggiuntivi. La struttura completa dell'URL utilizzata dai client per chiamare il proxy API è la seguente: https://[host]/BASE_PATH/CONDITIONAL_FLOW_PATH Nota: il percorso di base deve essere univoco. Non puoi eseguire il deployment di due proxy API con lo stesso percorso di base. Se modifichi un proxy API di cui hai eseguito il deployment e imposti il percorso di base sullo stesso valore del percorso di base di un altro proxy API, Apigee annulla automaticamente il deployment del proxy API quando lo salvi. Prima di poter eseguire nuovamente il deployment del proxy API, devi modificare il percorso di base in modo che sia univoco. Utilizzare caratteri jolly nei percorsi di base Utilizza uno o più caratteri jolly /*/ nei percorsi di base dei proxy API per rendere i tuoi proxy API a prova di futuro. Ad esempio, un percorso di base /team/*/members consente ai client di chiamare https://[host]/team/blue/members e https://[host]/team/green/members senza che tu debba creare nuovi proxy API per supportare i nuovi team. Tieni presente che /**/ non è supportato.
Descrizione	(Facoltativo) Descrizione dell'API.
Destinazione (API esistente)	URL del servizio di backend richiamato da questo proxy API.

Importazione di un proxy API da un bundle proxy API

Nota: quando importi un proxy API da un bundle proxy API, è tua responsabilità configurare la sicurezza e aggiungere criteri al bundle. La UI non richiede di aggiungere sicurezza o criteri durante l'importazione del bundle, come descritto in Aggiungere la sicurezza più avanti in questa sezione.

Spesso definisci i proxy API come una raccolta di file XML, insieme ad altri file di supporto. Se definisci i proxy API come un insieme di file esterni ad Apigee, puoi mantenerli in un sistema di controllo del codice sorgente e quindi importarli in Apigee per i test e il deployment.

Per importare i proxy API da un bundle proxy API, segui questi passaggi:

1. Accedi alla procedura guidata Crea proxy come descritto in Creare un proxy API tramite l'interfaccia utente in precedenza in questa sezione.
2. Fai clic su Carica bundle di proxy.

3. Nella pagina Carica bundle proxy della procedura guidata proxy, inserisci le seguenti informazioni:

   Campo	Descrizione
   Pacchetto ZIP	File ZIP contenente la configurazione del proxy API. Trascina o fai clic per passare al file.
   Nome	Nome visualizzato per l'API. Il valore predefinito è il nome del file ZIP senza estensione.

4. Tocca Avanti.

5. Nella pagina Riepilogo, seleziona gli ambienti di deployment, se vuoi, e fai clic su Crea ed esegui il deployment

   Viene visualizzata una conferma che conferma che il nuovo proxy API è stato creato correttamente.

6. Fai clic su Modifica proxy per visualizzare la pagina dei dettagli relativi al proxy API.

Creazione di proxy API gRPC

Al momento, oltre ai proxy API REST, Apigee supporta i proxy API gRPC con supporto solo del passthrough. Con il supporto del passthrough, il payload gRPC è a sua volta opaco ad Apigee e il traffico viene instradato dal client gRPC al server di destinazione gRPC preconfigurato nella configurazione di destinazione.

Al momento, i proxy API gRPC Apigee:

• Supporta le richieste gRPC unari.
• Impossibile utilizzare criteri che influiscono sul payload.
• Può essere utilizzato in prodotti API non associati a proxy GraphQL o REST. Le quote specifiche del prodotto API e altre impostazioni operative vengono applicate a tutti i proxy del prodotto.
• Non sono supportati in Apigee hybrid.
• Utilizza due variabili di flusso specifiche per gRPC: request.grpc.rpc.name e request.grpc.service.name.
• Può essere monitorato con queste variabili di dati di Apigee Analytics specifiche per gRPC: x_apigee_grpc_rpc_name, x_apigee_grpc_service_name e x_apigee_grpc_status.
• Restituisci i codici di stato gRPC.

Devi inoltre configurare il bilanciatore del carico per supportare gRPC. Vedi Utilizzo di gRPC con le applicazioni e Utilizzo dei comandi di gcloud CLI per creare il routing per gRPC.

Per creare un proxy API gRPC, devi prima definire un server di destinazione gRPC (consulta la pagina relativa alla creazione di TargetServer) e specificare il server di destinazione durante la creazione del nuovo proxy.

Nota: la configurazione del proxy gRPC tramite la UI di Apigee è supportata solo tramite l'UI di Apigee nella console Cloud, non tramite altre console Apigee.

Utilizzo dei comandi dell'interfaccia a riga di comando gcloud per creare il routing per gRPC

Questa sezione mostra comandi di esempio per creare il routing per i proxy gRPC utilizzando gcloud CLI. Le istruzioni includono la configurazione dei bilanciatori del carico, un server di destinazione e un gruppo di istanze gestite.

Questa sezione non è una guida esaustiva per la creazione del routing. Questi esempi potrebbero non essere appropriati per tutti i casi d'uso. Inoltre, queste istruzioni presuppongono familiarità con il routing esterno (MIG) e la configurazione gRPC del bilanciatore del carico Cloud.

Imposta le variabili di ambiente

Queste variabili di ambiente vengono utilizzate nei comandi delle sottosezioni.

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

Esempi di comandi gcloud CLI per creare il routing per i proxy gRPC utilizzando nuovi bilanciatori del carico

Questa sezione mostra comandi di esempio per creare proxy gRPC utilizzando gcloud CLI e un nuovo bilanciatore del carico. Le istruzioni includono la configurazione del bilanciatore del carico, di un server di destinazione e di un gruppo di istanze gestite.

Crea il modello di istanza

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-10 \
--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

Crea il gruppo di istanze gestite

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

Configurare la scalabilità automatica

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

Definisci una porta denominata

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

Crea un certificato e una chiave SSL gestiti da Google per il bilanciatore del carico

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

Confermare che è stato eseguito il provisioning del certificato

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

Crea il Global Cloud Load Balancer (GCLB)

1. Crea un controllo di integrità
   

   gcloud compute health-checks create https hc-apigee-envoy-443 \
   --project $PROJECT_ID --port 443 --global \
   --request-path /healthz/ingress

2. Crea il servizio di backend per http1
   

   gcloud compute backend-services create YOUR_BACKEND_1 \
   --project $PROJECT_ID \
   --protocol HTTPS \
   --health-checks hc-apigee-envoy-443 \
   --port-name https \
   --timeout 302s \
   --connection-draining-timeout 300s \
   --global

3. Crea il servizio di backend per 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

4. Aggiungere gruppi di istanze gestite al servizio di backend. In questo esempio stiamo riutilizzando il gruppo di istanze gestite, ma potresti anche creare una nuova coppia di gruppi di istanze gestite.
   

   gcloud compute backend-services add-backend YOUR_BACKEND_1 \
   --project $PROJECT_ID --instance-group $MIG_NAME \
   --instance-group-region $REGION \
   --balancing-mode UTILIZATION --max-utilization 0.8 --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

5. Creare una mappa URL di bilanciamento del carico. Verifica prima se disponi già di una mappa URL. In questo caso, assicurati di modificare la mappa in base ai requisiti riportati di seguito anziché sovrascriverla.
   

   Crea un file YAML o utilizza il tuo file esistente, in /tmp/apigee-map.yaml, con questa configurazione. Tieni presente che il backend http1 della mappa URL è predefinito.

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

   Convalida la mappa URL:

   gcloud compute url-maps validate --source /tmp/apigee-map.yaml --project $PROJECT_ID

   Crea la mappa degli URL con il routing basato su intestazioni:

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

Crea un proxy HTTPS di destinazione del bilanciamento del carico

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

Prenota un IP esterno IPV4 e crea regole firewall per il bilanciatore del carico

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

Crea una regola firewall

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

Esempi di comandi dell'interfaccia a riga di comando gcloud per creare il routing per i proxy gRPC per i bilanciatori del carico esistenti

Questa sezione mostra comandi di esempio per creare proxy gRPC utilizzando gcloud CLI e un bilanciatore del carico esistente. Le istruzioni includono la configurazione del bilanciatore del carico, di un server di destinazione e di un gruppo di istanze gestite.

Crea un altro servizio di backend per http2

# 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

Collega il secondo servizio di backend al gruppo di istanze gestite

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

Elenca la mappa URL per la piattaforma Apigee GCLB esistente

gcloud compute url-maps list -project $PROJECT_ID

Recupera il nome della mappa URL corretto utilizzato per il bilanciamento del carico di Apigee

gcloud compute url-maps export APIGEE_URL_MAP_NAME -project $PROJECT_ID

Crea un file YAML della mappa degli URL di bilanciamento del carico

Se hai già una mappa URL, unisci questa configurazione alla mappa esistente. Altrimenti, crea un file YAML in /tmp/apigee-map.yaml con questa configurazione.

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

Applica il nuovo YAML per il routing gRPC

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

Maggiore sicurezza

Nella pagina Criteri comuni della procedura guidata Crea proxy, seleziona il tipo di autorizzazione di sicurezza che vuoi aggiungere. La tabella seguente riassume le opzioni disponibili:

Autorizzazione di sicurezza	Descrizione
Chiave API	Aggiunge una semplice verifica della chiave API al proxy API che stai definendo. In risposta, la piattaforma API aggiunge un criterio VerificationAPIKey e un criterio AssegnaMessage al proxy API. Il criterio VerificationAPIKey convalida le chiavi API presentate richiedendo le app. Il criterio AttributionMessage rimuove la chiave API, fornita come parametro di query nella chiamata API, dalla richiesta inoltrata al server di backend.
OAuth 2.0	Aggiunge l'autenticazione basata su OAuth 2.0 al proxy API. Apigee aggiunge automaticamente i seguenti criteri al proxy API: un criterio per verificare un token di accesso e un altro per rimuovere il token di accesso dal messaggio prima di inoltrarlo al tuo servizio di backend. Per scoprire come ottenere un token di accesso, consulta OAuth.
Passaggio (nessuna autorizzazione)	Nessuna autorizzazione richiesta. Le richieste vengono passate al backend senza controlli di sicurezza su Apigee.

Aggiunta del supporto per CORS

La condivisione delle risorse tra origini (CORS) è un meccanismo standard che consente a un browser web di effettuare richieste dirette a un altro dominio. Lo standard CORS definisce un insieme di intestazioni HTTP che i browser web e i server utilizzano per implementare la comunicazione tra domini.

Per aggiungere il supporto per CORS, esegui una delle seguenti operazioni:

• Aggiunta del criterio CORS al preflusso della richiesta di ProxyEndpoint.
• Seleziona Aggiungi intestazioni CORS nella pagina Criteri comuni della procedura guidata Crea proxy.

Per informazioni più dettagliate sul supporto di CORS, inclusa l'aggiunta del supporto preflight CORS a un proxy, consulta la pagina relativa all'aggiunta del supporto di CORS a un proxy API.

Aggiunta di quote

Le quote proteggono il tuo servizio di backend dal traffico elevato in Quota. Vedi Quote. Non disponibile se è selezionata l'opzione Autorizzazione passthrough.

uso delle specifiche OpenAPI per generare proxy

Questa sezione illustra l'opzione Usa OpenAPI disponibile per la generazione da una specifica OpenAPI per i seguenti tipi di proxy API: inverso o nessun target.

Che cos'è una specifica OpenAPI?

"L'obiettivo dell'Open API Initiative (OAI) è creare, sviluppare e promuovere un formato di descrizione dell'API neutrale rispetto alla specifica Swagger." Per maggiori informazioni, consulta l'iniziativa OpenAPI.

Una specifica OpenAPI utilizza un formato standard per descrivere un'API RESTful. Scritta in formato JSON o YAML, una specifica OpenAPI è leggibile dalle macchine, ma è anche di facile lettura e comprensione per gli esseri umani. La specifica descrive gli elementi dell'API come percorso di base, percorsi e verbi, intestazioni, parametri di ricerca, operazioni, tipi di contenuti, descrizioni delle risposte e altro ancora. Inoltre, una specifica OpenAPI viene comunemente utilizzata per generare la documentazione dell'API.

Il seguente frammento di una specifica OpenAPI descrive il servizio di destinazione fittizio di Apigee, http://mocktarget.apigee.net. Per saperne di più, consulta la specifica OpenAPI per l'esempio helloworld.

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
...

Con la procedura guidata Crea proxy, puoi importare una specifica OpenAPI e utilizzarla per generare un proxy API. Una volta generato il proxy, puoi utilizzare l'interfaccia utente di Apigee per svilupparlo ulteriormente aggiungendo criteri, implementando codice personalizzato e così via, proprio come qualsiasi proxy Apigee.

Creazione di un proxy API da una specifica OpenAPI

Crea i proxy API da una specifica OpenAPI. Con pochi clic potrai disporre di un proxy API con percorsi, parametri, flussi condizionali ed endpoint di destinazione generati automaticamente. Successivamente, puoi aggiungere funzionalità quali la sicurezza OAuth, la limitazione di frequenza e la memorizzazione nella cache.

Nella procedura guidata Crea proxy, fai clic su Utilizza specifica OpenAPI e segui la procedura guidata per creare un proxy di destinazione inverso o assente da una specifica OpenAPI. Per maggiori dettagli, consulta la pagina relativa alla creazione di un proxy API da una specifica OpenAPI.

Creazione di una nuova revisione di un proxy API

Crea una nuova revisione di un proxy API, come descritto di seguito.

Per creare una nuova revisione di un proxy API, segui questi passaggi:

1. Accedi all'interfaccia utente di Apigee.
2. Nella barra di navigazione, seleziona Sviluppo > Proxy API.
3. Fai clic sul proxy API nell'elenco da copiare.

4. Fai clic sulla scheda Sviluppo.

5. Seleziona il pulsante Salva, quindi Salva come nuova revisione.

Backup di un proxy API

Puoi eseguire il backup di un proxy API esistente come un insieme di file XML in un bundle proxy API. Una volta esportato in un bundle, puoi importare il proxy API in un nuovo proxy, come descritto nella sezione Importare un proxy API da un bundle proxy API in precedenza in questa sezione. Per maggiori informazioni, consulta Scaricare i proxy API.

Creazione di un proxy API mediante l'API

Per creare un proxy API utilizzando l'API, consulta la sezione Creazione di un proxy API.