Utilizzo dei proxy API di esempio

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Prerequisiti

Dovrai avere un account su http://enterprise.apigee.com. Puoi registrarti per un account di prova di http://accounts.apigee.com/accounts/sign_up.

Per utilizzare i campioni, devi anche avere quanto segue:

Strumento	Descrizione
Git	Gli esempi si trovano su GitHub. Se non hai installato Git, fai riferimento a Istruzioni per la configurazione 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 di Apigee è necessario Python. Python è presente nella maggior parte dei su un Mac su cui è installato XCode, su un computer Windows su cui è installato Cygwin e in molti altri contesti. Per ottenere Python, fai riferimento Pagina di download Python.
curl	Anche gli script di configurazione di esempio utilizzano curl. Assicurati che curl sia installato e disponibili sul tuo percorso (esegui il comando which curl per verificare se è disponibile del tuo sistema).
dos2unix	Se esegui Cygwin su Windows, potrebbe essere necessaria anche la dos2unix utilità. 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 dell'API di esempio proxy

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

1. Dopo aver scaricato gli esempi, vai alla directory /setup, come mostrato 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 di 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. (La procedura richiede 3-4 minutes.) Segui le istruzioni per eseguire il deployment di prodotti, sviluppatori e app API (utilizzati OAuth).

5. Una volta completato lo script di deployment, vai alla directory sample-proxies. Nella directory sample-proxies, troverai una directory per ogni proxy di esempio. In ogni è un file README.md con informazioni sull'esecuzione dell'esempio e due script che ti aiuta ad apportare piccole modifiche agli esempi, a eseguire il deployment e quindi a richiamare l'esempio per visualizzare l'effetto della modifica:
   • invoke.sh: esegui questo script per richiamare la versione dell'API di cui è stato eseguito il deployment proxy.
   • deploy.sh: esegui questo script per eseguire il deployment del proxy API dopo aver eseguito modifiche.

Richiama i proxy API di esempio

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

Dalla directory /sample-proxies/proxy_name, esegui il comando seguenti:

sh invoke.sh

Questa operazione richiama il proxy in esecuzione nell'ambiente di test nella tua organizzazione.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi, consulta quanto segue:

• Introduzione alla risoluzione dei problemi
• Risoluzione dei problemi di Windows/Cygwin

Modifica e riutilizza i proxy API di esempio

L'utilizzo tipico dei proxy di esempio è la modifica, il deployment e il richiamo. Ciò consente di apportare piccole modifiche e per vedere l'effetto che hanno sul messaggio di risposta.

Per modificare un proxy API di esempio in modo che punti a un servizio di backend diverso, modifica il File XML di configurazione nella seguente posizione:

/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 punta 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/, allora modificare la configurazione come segue:

<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 allo stesso modo per utilizzare la funzionalità proxy API rispetto ai servizi di destinazione esistenti. In alcuni casi, tuttavia, il comportamento del proxy API dipende formati di messaggi specifici, per cui i proxy potrebbero richiedere ulteriori modifiche alla configurazione.