Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Gli esempi di API Apigee Edge contengono proxy API, criteri, codice e strumenti di esempio che illustrano le funzionalità dei servizi API Apigee Edge descritti di seguito.
Per istruzioni sull'utilizzo degli esempi, vedi Utilizzo dei proxy API di esempio.
Impara facendo pratica
Vuoi iniziare subito a fare pratica e creare una solida base di conoscenze su Apigee Edge? Abbiamo una libreria di esempi "learn-edge" su GitHub che ti consentono di eseguire rapidamente il deployment, richiamare e tracciare alcuni proxy di esempio, a partire dal proxy più semplice e passando a proxy che illustrano la convalida della chiave API, la quota, la memorizzazione nella cache delle risposte, la gestione degli errori e altro ancora.
Una volta clonato il repository e configurato l'ambiente (operazione che richiede pochi minuti), puoi provare ogni esempio in meno di un minuto. Poiché ogni campione crea una nuova revisione dello stesso proxy, l'ambiente non verrà ingombrato da molti campioni. Puoi cambiare le revisioni, eseguire di nuovo il deployment di una revisione diversa nell'interfaccia utente di gestione ed esaminare il codice 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.
Fai una prova. https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Esempi di cookbook di Document AI
Viene fornito un insieme di esempi per gli argomenti del ricettario del 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 API pubbliche, combina i risultati e genera una risposta arricchita per l'app client. (Nota: questo proxy API implementa la stessa funzionalità del mashup delle norme, 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 i contenuti e le intestazioni della risposta in lettere maiuscole. | 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 di callout Java. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | Un'applicazione completa che utilizza la composizione delle policy 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 una determinata norma in un campione, cerca nella colonna Tipi di norme di seguito quella che ti interessa, quindi fai clic sul nome del campione nella colonna Nome. (I criteri sono collegati alle rispettive pagine di riferimento nella documentazione).
Riferimenti e strumenti
Oltre agli esempi di ricette per documenti e ai proxy di esempio nelle tabelle precedenti, gli esempi di GitHub Edge 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. Devi convalidare sia la chiave 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/D |
| condition-pattern-matching | Questo proxy ti consente di provare e testare facilmente le istruzioni condizionali in un flusso proxy API. | AssignMessage | N/D |
| access-entity | Mostra come recuperare i profili per le entità dall'archivio dati Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
nessuno |
| apikey | Implementa una semplice convalida 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. | AssignMessage Javascript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | Implementa l'applicazione forzata di criteri condizionali semplici. 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 un 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 il codice di esempio |
| oauth-client-credentials | Mostra un endpoint del token OAuth 2.0 completamente funzionante configurato per il tipo di concessione delle credenziali client. | GenerateAccessToken | nessuno |
| oauth-login-app | Deprecato. Ti consigliamo di esaminare invece l'esempio oauth-advanced. | ||
| oauth-validate-key-secret | Illustra una tecnica per convalidare la chiave e il segreto 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 nella cache il token 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 |
| impaginazione | Impagina un messaggio di risposta XML in base ai parametri di limite e offset forniti dal client | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| response-cache | Mostra come memorizzare nella cache le previsioni meteo su Edge per 10 minuti. | ResponseCache AssignMessage |
nessuno |
| simple-python | Mostra uno scenario semplice di allegato di 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 |
calculateaddress.py fixwsdl.xsl |
| streaming | Mostra una configurazione di streaming HTTP. | nessuno | nessuno |
| target-reroute | Mostra l'utilizzo di 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 mobili con risorse limitate. | AssignMessage Javascript |
MobileTimeline.js |
| twitter-oembed | Trasforma le risposte della cronologia (ad es. da statuses/user_timeline.json) in una risposta oEmbed che contiene i dati della cronologia come contenuti HTML avanzati. | AssignMessage JavaScript |
search-oembed.js |
| variabili | Mostra 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 di schema XML che puoi utilizzare come riferimento durante la configurazione di proxy API, policy, 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 lo esegue 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 programmare 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 nel forum per sviluppatori Apigee.