Utilizzo dei proxy API di esempio

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

Prerequisiti

Devi disporre di un account su http://enterprise.apigee.com. Puoi registrarti per un account di prova all'indirizzo http://accounts.apigee.com/accounts/sign_up.

Per utilizzare gli esempi, devi avere anche quanto segue:

Strumento Descrizione
Git Gli esempi si trovano su GitHub. Se non hai installato Git, consulta le istruzioni di configurazione di Git di GitHub. Se non vuoi installare Git, puoi sfogliare i file e scaricare un file ZIP da https://github.com/apigee/api-platform-samples.
Python

Per eseguire lo strumento di deployment Apigee è necessario Python. Python è presente nella maggior parte degli ambienti Linux, su un Mac con XCode installato, su una macchina Windows su cui è installato Cygwin e in molti altri posti.

Per ottenere Python, fai riferimento alla pagina di download di Python.

curl Anche gli script di configurazione di esempio utilizzano curl. Assicurati che curl sia installato e disponibile nel tuo percorso (esegui il comando which curl per verificare se è disponibile nel tuo sistema).
dos2unix Se esegui Cygwin su Windows, potrebbe essere necessaria anche l'utilità dos2unix. Il programma di installazione di Cygwin ti consente di installare l'utilità.

Scarica gli esempi

Per ottenere i file di esempio, utilizza git clone come illustrato nell'esempio seguente:

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

Importa ed esegui il deployment dei proxy API di esempio

Importa ed esegui il deployment degli esempi dalla riga di comando:

  1. Dopo aver scaricato gli esempi, vai alla directory /setup, come illustrato nell'esempio seguente:
    cd setup
  2. Nella directory /setup, individua il file setenv.sh.
  3. Modifica questo file per impostare la tua organizzazione, l'indirizzo email associato al tuo nome utente e l'ambiente (di produzione o test) in cui vuoi eseguire il deployment dei proxy API.
  4. Dopo aver modificato setenv.sh, esegui questo comando:
    sh deploy_all.sh

    Questo script esegue il deployment di tutti gli esempi di proxy API nella tua organizzazione. Il processo richiede 3-4 minuti. Segui le istruzioni per eseguire il deployment di prodotti API, sviluppatori e app (utilizzati per OAuth).

  5. Al termine dello script di deployment, vai alla directory dei proxy di esempio. Nella directory sample-proxies troverai una directory per proxy di esempio. In ogni directory è presente un file README.md con informazioni sull'esecuzione dell'esempio e due script utili per apportare piccole modifiche agli esempi, eseguirne il deployment e quindi richiamare l'esempio per verificare l'effetto della modifica:
    • invoke.sh: esegui questo script per richiamare la versione di cui è stato eseguito il deployment del proxy API.
    • deploy.sh: esegui questo script per eseguire il deployment del proxy API dopo aver apportato eventuali modifiche.

Richiama i proxy API di esempio

A ogni proxy di esempio è associato uno script shell che può essere utilizzato per richiamare il proxy API dopo il deployment.

Dalla directory /sample-proxies/proxy_name, esegui quanto segue:

sh invoke.sh

Questo richiama il proxy in esecuzione nell'ambiente di test della tua organizzazione.

Risolvere i problemi

Per informazioni sulla risoluzione dei problemi, vedi quanto segue:

Modifica e riutilizza i proxy API di esempio

L'utilizzo tipico dei proxy di esempio è modificare, eseguire il deployment e richiamare. Ciò ti consente di apportare piccole modifiche e quindi di vedere quale effetto hanno sul messaggio di risposta.

Per modificare un proxy API di esempio in modo che rimandi a un servizio di backend diverso, modifica il file di configurazione XML nel percorso seguente:

/apiproxy/targets/target_name.xml

Ad esempio, per indirizzare l'esempio di chiave API al tuo servizio di backend, individua questo file:

/apikey/apiproxy/targets/default.xml

Se la configurazione predefinita rimanda a http://mocktarget.apigee.net, ad esempio:

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

e il tuo servizio di backend è disponibile all'indirizzo http://api.myproject.com/, quindi modifichi la configurazione in modo da avere il seguente aspetto:

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

Dopo aver salvato le modifiche, esegui il deployment del proxy API come illustrato nell'esempio seguente:

sh deploy.sh

Gli altri proxy API possono essere modificati nello stesso modo per utilizzare la funzionalità proxy API nei servizi di destinazione esistenti. Tuttavia, in alcuni casi, il comportamento del proxy API dipende da formati di messaggi specifici, pertanto i proxy potrebbero richiedere ulteriori modifiche alla configurazione.