Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Gli esempi di API Apigee Edge contengono proxy API, criteri, codice e strumenti di esempio che illustrano le funzionalità dei servizi API Apigee Edge descritte di seguito.
Per istruzioni sull'utilizzo degli esempi, consulta Utilizzare i proxy API di esempio.
Impara facendo pratica
Vuoi sbizzarrirti in fretta e iniziare a creare una solida knowledge base su Apigee Edge? Abbiamo una libreria di esempi "learn-edge" in GitHub che ti consente di eseguire rapidamente il deployment, richiamare e tracciare alcuni proxy di esempio, a partire dal proxy più semplice per passare ai proxy che illustrano convalida delle chiavi API, quota, memorizzazione nella cache delle risposte, gestione dei guasti e altro ancora.
Dopo aver clonato il repository e configurato l'ambiente (l'operazione richiede solo pochi minuti), puoi provare ogni campione in meno di un minuto. Inoltre, poiché ogni campione crea una nuova revisione dello stesso proxy, nel tuo ambiente non sarà presente una grande quantità di campioni. Puoi cambiare revisione, eseguire nuovamente il deployment di una revisione diversa nell'interfaccia utente di gestione e controllare il codice proxy in qualsiasi momento. Il file Leggimi di ogni esempio fornisce anche un breve resoconto di cosa sta facendo l'esempio e come è configurato.
Prova! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Esempi di libri di ricette di Documenti
Viene fornito un insieme di esempi per gli argomenti del libro di ricette del proxy API.
| Nome | Descrizione | Tipi di norme | Risorse |
|---|---|---|---|
| JavaScript-cookbook | Mostra un semplice snippet JavaScript che aggiunge intestazioni HTTP da variabili, trasforma un report meteo in formato XML da JSON a XML e riduce i contenuti per i client mobile. | minimi.js setHeaders.js |
|
| JavaScript-mashup-cookbook | Un'applicazione JavaScript completa che chiama le API pubbliche, combina i risultati e genera una risposta avanzata per l'app client. Nota: questo proxy API implementa la stessa funzionalità del mashup di criteri, dimostrando che lo stesso problema può essere risolto utilizzando tecniche diverse. | JavaScript | MashItUp.js |
| java-hello | Semplice callout Java Hello World. | JavaCallout | JavaHello.java |
| java-cookbook | Converte le intestazioni e il contenuto della risposta in lettere maiuscole. | JavaCallout |
ResponseUppercase.java |
| java-properties | Viene illustrato come utilizzare le proprietà in un callout Java. | JavaCallout | JavaProperties.java |
| errore-java | Mostra i pattern di gestione degli errori che puoi utilizzare nel codice callout Java. | JavaCallout | JavaError.java |
| criteri-mashup-cookbook | Un'applicazione completa che utilizza la composizione dei criteri per chiamare due API pubbliche, combina i risultati e genera una risposta avanzata per l'app client. Nota: questo proxy API implementa la stessa funzionalità del mashup JavaScript, dimostrando che lo stesso problema può essere risolto utilizzando tecniche diverse. | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
Proxy API di esempio
I seguenti proxy API si trovano in GitHub, dove le pagine Leggimi forniscono descrizioni dettagliate degli esempi. Se ti interessa conoscere il funzionamento di una determinata norma in un esempio, cerca la norma che ti interessa nella colonna Tipi di norme riportata di seguito, poi fai clic sul nome di esempio nella colonna Nome. I criteri sono collegati alle rispettive pagine di riferimento nei documenti.
Riferimenti e strumenti
Oltre agli esempi del libro di ricette del documento e ai proxy di esempio nelle tabelle precedenti, gli esempi di GitHub di Edge contengono anche queste risorse:
| Nome | Descrizione | Tipi di norme | Risorse |
|---|---|---|---|
| protezione-reserva | Il criterio di protezione dalle minacce tramite espressioni regolari può proteggere le API e i microservizi di backend dagli attacchi SQL injection. | N/A | |
| oauth-validate-key-secret | Stai implementando il flusso del tipo di concessione della password OAuth. Devi convalidare sia la chiave del client dell'applicazione sia il secret su Edge prima di chiamare un provider di identità esterno per convalidare le credenziali dell'utente. | OAuthV2, altri | N/A |
| corrispondenza-condizione-pattern | Questo proxy consente di provare e testare facilmente le istruzioni condizionali in un flusso proxy API. | AssignMessage | N/A |
| entità-accesso | Mostra come recuperare i profili per le entità dal datastore Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
Nessuno |
| apikey | Implementa una semplice convalida delle chiavi API | VerifyAPIKey AssignMessage Quota |
Nessuno |
| callout-asinc | Mostra un semplice callout asincrono utilizzando il httpClient di JavaScript. | JavaScript | assemble_response.js callout.js |
| base64encoder | Viene illustrato come chiamare le include funzionalità di JavaScript dalle risorse JavaScript nei proxy API. | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| criteri-condizionali | Implementa una semplice applicazione condizionale dei criteri. Quando una richiesta contiene un'intestazione HTTP Responsetime:true, un criterio esegue uno script Python che aggiunge un insieme di metriche relative alle prestazioni al messaggio di risposta, sotto forma di intestazioni HTTP | Script (Python) | timer.py |
| endpoint-dinamico | Implementa il routing condizionale semplice in uno scenario leggermente più complesso, che definisce due URL e una route predefinita. | Nessuno | Nessuno |
| jira-release-notes | Questo è il proxy API utilizzato dal team addetto alla documentazione di Apigee per generare note di rilascio da Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-media-credenziale | Questo esempio mostra come eseguire la mediazione delle credenziali Kerberos su Apigee Edge. | JavaCallout | File JAR Java |
| oauth-advanced | Un esempio funzionante completo del flusso del tipo di concessione del codice di autorizzazione, con Apigee Edge come server di autorizzazione. |
GenerateAccessToken Molti altri... |
vedi il codice di esempio |
| credenziali-client-oauth | Mostra un endpoint del token OAuth 2.0 completamente funzionante configurato per il tipo di concessione delle credenziali client. | GenerateAccessToken | Nessuno |
| app oauth-login- | Deprecato. Ti consigliamo di esaminare invece l'esempio oauth-advanced. | ||
| oauth-validate-key-secret | Illustrazione di una tecnica per convalidare la chiave e il secret del client prima di chiamare un provider di identità per convalidare le credenziali utente nel flusso del tipo di concessione delle password. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
Nessuno |
| oauth-verify-accesstoken | Mostra un proxy API configurato per convalidare i token di accesso OAuth 2.0 e verificare la quota. | VerifyAccessToken Quota |
Nessuno |
| oauth10a-3wired | Mostra una configurazione a tre vie OAuth 1.0a. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
Nessuno |
| outbound-oauth | Utilizza l'API Microsoft Azure traduttore per tradurre i tweet. Per farlo, effettua una chiamata in uscita per ottenere un token di accesso OAuth, quindi memorizza il token nella cache utilizzando i criteri di memorizzazione nella cache dei Servizi API, riutilizzando il token memorizzato nella cache ogni volta che viene effettuata una chiamata in uscita. Include inoltre un'app browser dimostrativa utilizzata per richiamare il proxy API. | AssignMessage LookupCache PopulateCache Javascript |
api-config.js api-token-get.js Traduttore-query.js Traduttore-results.js |
| paginazione | Impagina un messaggio di risposta XML in base ai parametri di limite e offset forniti dal client | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| cache-delle-risposta | Mostra come memorizzare nella cache le previsioni meteo su Edge per 10 minuti. | ResponseCache AssignMessage |
Nessuno |
| simple-python | Mostra uno scenario semplice in cui viene collegato uno script Python nella risposta che aggiunge un valore di intestazione. |
Script (Python) | setHeader.py |
| sapone | Mostra una trasformazione XSL che riscrive un file WSDL in risposta a una richiesta con il parametro di query ?wsdl. | AssignMessage ExtractVariables Script (Python) XSL |
computeaddress.py fixwsdl.xls |
| in streaming | Mostra una configurazione di flussi di dati HTTP. | Nessuno | Nessuno |
| reindirizzamento-target | Viene illustrato l'utilizzo di JavaScript per la selezione dinamica di un URL di destinazione in base ai contenuti di un messaggio di richiesta. | ExtractVariables JavaScript |
rewriteTargetUrl.js |
| sequenza-temporativa-twitter-mobile | Illustra come utilizzare JavaScript per eliminare i parametri non necessari dai tweet, generando una sequenza temporale di Twitter semplificata e adatta ai dispositivi mobili con risorse limitate. | AssignMessage JavaScript |
MobileTimeline.js |
| twitter-oembed | Trasforma le risposte della sequenza temporale (ad esempio da status/user_timeline.json) in una risposta oEmbed che contiene i dati della sequenza temporale sotto forma di contenuti HTML avanzati. | AssignMessage JavaScript |
search-oembed.js |
| variabili | Viene illustrato come estrarre e impostare le variabili in base al trasporto e ai contenuti dei messaggi JSON e XML. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
| xmltojson | Converte i dati della risposta da XML a JSON. | XMLToJSON JSONToXML |
Nessuno |
|
|
File XML schema che puoi utilizzare come riferimento durante la configurazione di proxy API, criteri, prodotti API e profili di sviluppatori e app. |
||
|
|
Contiene uno strumento di deployment, deploy.py, che importa un proxy API in un'organizzazione su Apigee Edge e quindi ne esegue il deployment nell'ambiente specificato. |
||
|
|
Lo strumento snapshot dell'organizzazione recupera le impostazioni dell'organizzazione, tra cui sviluppatori, prodotti API, host virtuali, mappe chiave/valore e così via. Può essere utilizzato per eseguire il backup dei dettagli di un'organizzazione o per rilevare le impostazioni all'interno di un'organizzazione. |
Apigee-127
Se sei un programmatore, Apigee-127 ti aiuterà a programmare i proxy API con Node.js e Swagger. Puoi trovare esempi di a127 anche su GitHub: https://github.com/apigee-127/a127-samples.
Condividi la tua esperienza
Condividi le tue esperienze sul forum per gli sviluppatori di Apigee.