Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Gli esempi di API Apigee Edge contengono i proxy API, i criteri, il codice e gli strumenti di esempio che illustrano le funzionalità dei servizi API Apigee Edge descritti di seguito.
Per istruzioni sull'utilizzo degli esempi, vedi Utilizzare i proxy API di esempio.
Impara facendo pratica
Vuoi iniziare subito a creare una solida base di conoscenze su Apigee Edge? Abbiamo una libreria di esempi "learn-edge" su GitHub che ti consente di eseguire rapidamente il deployment, richiamare, e tracciare alcuni proxy di esempio, a partire dal proxy più semplice e passando ai proxy che illustrano la convalida delle chiavi API, la quota, la memorizzazione nella cache delle risposte, la gestione dei guasti e altro ancora.
Dopo aver clonato il repository e configurato l'ambiente (bastano pochi minuti), puoi provare ogni esempio in meno di un minuto. Poiché ogni esempio crea una nuova revisione dello stesso proxy, l'ambiente non verrà ingombrato da molti esempi. Puoi cambiare revisione, eseguire di nuovo il deployment di una revisione diversa nell'interfaccia utente di gestione e visualizzare il codice del proxy in qualsiasi momento. Il file README di ogni esempio fornisce anche una breve descrizione di ciò che fa l'esempio e di come è configurato.
Prova subito: https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Esempi di cookbook di documentazione
Viene fornito un insieme di esempi per gli argomenti del cookbook dei proxy API.
| Nome | Descrizione | Tipi di norme | Risorse |
|---|---|---|---|
| javascript-cookbook | Mostra un semplice snippet JavaScript che aggiunge intestazioni HTTP dalle variabili, trasforma un report meteo in formato XML da JSON a XML e riduce i contenuti per i client mobile. | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | Un'applicazione JavaScript completa che chiama le API pubbliche, combina i risultati e genera una risposta arricchita per l'app client. (Nota: questo proxy API implementa la stessa funzionalità di policy-mashup, 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 in maiuscolo i contenuti e le intestazioni delle risposte. | JavaCallout |
ResponseUppercase.java |
| java-properties | Mostra come utilizzare le proprietà in un callout Java. | JavaCallout | JavaProperties.java |
| java-error | Mostra i pattern di gestione degli errori che puoi utilizzare nel codice del callout Java. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | Un'applicazione completa che utilizza la composizione dei criteri per chiamare due API pubbliche, combina i risultati e genera una risposta arricchita per l'app client. (Nota: questo proxy API implementa la stessa funzionalità di javascript-mashup, 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 su GitHub, dove le pagine README forniscono descrizioni dettagliate degli esempi. Se ti interessa il funzionamento di un criterio specifico in un esempio, cerca quello che ti interessa nella colonna Tipi di norme di seguito, quindi fai clic sul nome dell'esempio nella colonna Nome. (I criteri sono collegati alle rispettive pagine di riferimento nella documentazione.)
Riferimenti e strumenti
Oltre agli esempi di cookbook di documentazione e ai proxy di esempio nelle tabelle sopra, gli esempi di Edge GitHub contengono anche queste risorse:
| Nome | Descrizione | Tipi di norme | Risorse |
|---|---|---|---|
| regex-protection | Il criterio di protezione dalle minacce delle espressioni regolari può proteggere le API di backend e i microservizi dagli attacchi di SQL injection. | N/D | |
| oauth-validate-key-secret | Stai implementando il flusso del tipo di concessione della password OAuth. Prima di chiamare un provider di identità esterno per convalidare le credenziali dell'utente, devi convalidare sia la chiave client dell'applicazione sia il secret su Edge. | OAuthV2, altri | N/D |
| condition-pattern-matching | Questo proxy ti consente di provare e testare facilmente le istruzioni condizionali in un flusso di proxy API. | AssignMessage | N/D |
| access-entity | Mostra come recuperare i profili delle entità dall'archivio dati di Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
nessuno |
| apikey | Implementa la convalida semplice delle chiavi API | VerifyAPIKey AssignMessage Quota |
nessuno |
| async-callout | Mostra un semplice callout asincrono utilizzando httpClient JavaScript. | Javascript | assemble_response.js callout.js |
| base64encoder | Mostra come chiamare le inclusioni JavaScript dalle risorse JavaScript nei proxy API proxy. | AssignMessage Javascript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | Implementa l'applicazione semplice dei criteri condizionali. Quando una richiesta contiene un'intestazione HTTP responsetime:true, un criterio esegue uno script Python che aggiunge un insieme di metriche di rendimento al messaggio di risposta, come intestazioni HTTP | Script (Python) | timer.py |
| dynamic-endpoint | 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 di documentazione di Apigee per generare le note di rilascio da Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediation | Questo esempio mostra come eseguire la mediazione delle credenziali Kerberos su Apigee Edge. | JavaCallout | File JAR Java |
| oauth-advanced | Un esempio completo e funzionante del flusso del tipo di concessione del codice di autorizzazione, con Apigee Edge come server di autorizzazione. |
GenerateAccessToken Molti altri... |
vedi l'esempio di codice |
| oauth-client-credentials | Mostra un endpoint del token OAuth 2.0 completamente funzionale configurato per il tipo di concessione delle credenziali client. | GenerateAccessToken | nessuno |
| oauth-login-app | Deprecato. Ti consigliamo di consultare l'esempio oauth-advanced. | ||
| oauth-validate-key-secret | Illustra 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 della 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-3legged | Mostra una configurazione OAuth 1.0a a tre passaggi. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
nessuno |
| outbound-oauth | Utilizza l'API Microsoft Azure Translator per tradurre i tweet. A questo scopo, 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 anche un'app browser dimostrativa utilizzata per richiamare il proxy API. | AssignMessage LookupCache PopulateCache Javascript |
api-config.js api-token-get.js translate-query.js translate-results.js |
| pagination | Impagina un messaggio di risposta XML in base ai parametri limit e offset forniti dal client | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| response-cache | Mostra come memorizzare nella cache le previsioni del tempo su Edge per 10 minuti. | ResponseCache AssignMessage |
nessuno |
| simple-python | Mostra un semplice scenario di collegamento di uno script Python nella risposta che aggiunge un valore di intestazione. |
Script (Python) | setHeader.py |
| soap | 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 |
calculateaddress.py fixwsdl.xsl |
| streaming | Mostra una configurazione di streaming HTTP. | nessuno | nessuno |
| target-reroute | Mostra come utilizzare JavaScript per selezionare dinamicamente un URL di destinazione in base ai contenuti di un messaggio di richiesta. | ExtractVariables Javascript |
rewriteTargetUrl.js |
| twitter-mobile-timeline | Mostra come utilizzare JavaScript per rimuovere i parametri non necessari dai tweet, ottenendo una sequenza temporale di Twitter semplificata e adatta ai dispositivi mobile con risorse limitate. | AssignMessage Javascript |
MobileTimeline.js |
| twitter-oembed | Trasforma le risposte della sequenza temporale (ad es. da statuses/user_timeline.json) in una risposta oEmbed che contiene i dati della sequenza temporale come contenuti HTML avanzati. | AssignMessage JavaScript |
search-oembed.js |
| variables | Mostra come estrarre e impostare le variabili in base ai contenuti dei messaggi di trasporto, JSON e XML e al contenuto dei messaggi. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
| xmltojson | Converte i dati di risposta da XML a JSON. | XMLToJSON JSONToXML |
nessuno |
|
|
File di schemi XML 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 poi ne esegue il deployment nell'ambiente specificato. |
||
|
|
Lo strumento di snapshot dell'organizzazione recupera le impostazioni dell'organizzazione, inclusi 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 scoprire le impostazioni di un'organizzazione. |
Apigee-127
Se sei un programmatore, Apigee-127 ti consente di iniziare subito a programmare i proxy API con Node.js e Swagger. Puoi anche trovare esempi di a127 su GitHub: https://github.com/apigee-127/a127-samples.
Condividi la tua esperienza
Condividi le tue esperienze nel forum degli sviluppatori Apigee.