Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
Les exemples d'API Apigee Edge contiennent les exemples de proxys, de règles, de code et d'outils d'API qui illustrent les fonctionnalités des services d'API Apigee Edge décrits ci-dessous.
Pour obtenir des instructions sur l'utilisation des exemples, consultez la section Utiliser les exemples de proxys d'API.
Apprenez par la pratique
Vous souhaitez vous salir les mains rapidement et commencer à créer une base de connaissances solide sur Apigee Edge ? Nous disposons d'une bibliothèque d'exemples "learn-edge" dans GitHub qui vous permet de déployer, d'appeler et de tracer rapidement des exemples de proxys, en commençant par le proxy le plus simple, puis en passant aux proxys illustrant la validation des clés API, les quotas, la mise en cache des réponses, la gestion des pannes, etc.
Une fois que vous avez cloné le dépôt et configuré votre environnement (cela ne prend que quelques minutes), vous pouvez tester chaque exemple en moins d'une minute. De plus, comme chaque échantillon crée une nouvelle révision du même proxy, votre environnement ne sera pas encombré d'un grand nombre d'échantillons. Vous pouvez changer de révision, redéployer une révision différente dans l'interface utilisateur de gestion et examiner le code de proxy à tout moment. Le fichier README de chaque exemple donne également un bref aperçu de ce que fait l'exemple et de sa configuration.
Essayez-le ! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Exemples de livres de recettes Docs
Un ensemble d'exemples est fourni pour les sujets du livre de recettes sur les proxys d'API.
| Nom | Description | Types de règles | Ressources |
|---|---|---|---|
| javascript-cookbook | montre un extrait de code JavaScript simple qui ajoute des en-têtes HTTP à partir de variables, transforme un bulletin météo au format XML de JSON en XML et réduit le contenu pour les clients mobiles. | minimiser.js setHeaders.js |
|
| javascript-mashup-cookbook | Application JavaScript complète qui appelle des API publiques, combine les résultats et génère une réponse enrichie pour l'application cliente. Remarque: ce proxy d'API implémente la même fonctionnalité que la combinaison de stratégies, ce qui démontre que le même problème peut être résolu à l'aide de différentes techniques. | JavaScript | MashItUp.js |
| java-hello | Légende Java simple "Hello World". | JavaCallout | JavaHello.java |
| java-cookbook | Convertit le contenu et les en-têtes de la réponse en majuscules. | JavaCallout |
ResponseUppercase.java |
| java-properties | Montre comment utiliser des propriétés dans une accroche Java. | JavaCallout | JavaProperties.java |
| erreur-java | Cet exemple présente les schémas de gestion des erreurs que vous pouvez utiliser dans le code d'appel Java. | JavaCallout | JavaError.java |
| _policy-mashup-cookbook | Une application complète qui utilise la composition de règles pour appeler deux API publiques, combine les résultats et génère une réponse enrichie pour l'application cliente. Remarque: ce proxy d'API implémente la même fonctionnalité que le mashup JavaScript, ce qui démontre que le même problème peut être résolu à l'aide de différentes techniques. | AssignMessage ServiceCallout ExtractVariables JavaScript XMLToJSON |
GenerateResponse.js |
Exemples de proxys d'API
Les proxys d'API suivants se trouvent dans GitHub, où les pages Lisez-moi fournissent des descriptions détaillées des exemples. Si vous souhaitez connaître le fonctionnement d'une règle particulière dans un exemple, recherchez celle qui vous intéresse dans la colonne "Types de règles" ci-dessous, puis cliquez sur le nom de l'exemple dans la colonne "Nom". (Les stratégies sont liées à leurs pages de référence respectives dans la documentation.)
Documentation de référence et outils
Outre les exemples de livres de recettes et de proxys de la documentation dans les tableaux ci-dessus, les exemples GitHub Edge contiennent également les ressources suivantes:
| Nom | Description | Types de règles | Ressources |
|---|---|---|---|
| protection-regex | La stratégie de protection contre les menaces liées aux expressions régulières peut protéger vos API backend et vos microservices contre les attaques par injection SQL. | N/A | |
| oauth-validate-key-secret | Vous implémentez le flux de type d'attribution de mot de passe OAuth. Vous devez valider à la fois la clé et le secret du client d'application sur Edge avant d'appeler un fournisseur d'identité externe pour valider les identifiants de l'utilisateur. | OAuthV2 et d'autres | N/A |
| correspondance de condition/schéma | Ce proxy vous permet d'essayer et de tester facilement des instructions conditionnelles dans un flux de proxy d'API. | AssignMessage | N/A |
| entité-accès | Explique comment récupérer des profils pour les entités à partir du datastore Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
none |
| apikey | Implémente une validation simple des clés API | VerifyAPIKey AssignMessage Quota |
none |
| accroche asynchrone | Montre un exemple d'appel asynchrone simple à l'aide de JavaScript httpClient. | JavaScript | assemble_response.js callout.js |
| base64encoder | Montre comment appeler des inclusions JavaScript à partir de ressources JavaScript dans des proxys d'API. | AssignMessage JavaScript ; |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| Condition-policy | Met en œuvre une application simple de stratégie conditionnelle. Lorsqu'une requête contient un en-tête HTTP "responsetime:true", une stratégie exécute un script Python qui ajoute un ensemble de métriques de performances au message de réponse, sous forme d'en-têtes HTTP. | Script (Python) | timer.py |
| dynamic-endpoint | Met en œuvre un routage conditionnel simple dans un scénario légèrement plus complexe, qui définit deux URL et une route par défaut. | none | none |
| jira-release-notes | Il s'agit du proxy d'API utilisé par l'équipe de documentation Apigee pour générer les notes de version de Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediation | Cet exemple montre comment effectuer la médiation des identifiants Kerberos sur Apigee Edge. | JavaCallout | Fichier JAR Java |
| oauth-advanced | Exemple complet et pratique du flux de type d'attribution de code d'autorisation, avec Apigee Edge comme serveur d'autorisation. |
GenerateAccessToken Et bien d'autres... |
consultez l'exemple de code |
| oauth-client-credentials | montre un point de terminaison de jeton OAuth 2.0 entièrement fonctionnel, configuré pour le type d'attribution des identifiants client. | GenerateAccessToken | none |
| oauth-login-app | Obsolète. Nous vous recommandons plutôt d'examiner l'exemple oauth-advanced. | ||
| oauth-validate-key-secret | Illustre une technique de validation de la clé et du code secret du client avant d'appeler un fournisseur d'identité pour valider les identifiants de l'utilisateur dans le flux de type d'attribution de mot de passe. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
none |
| oauth-verify-accesstoken | Montre un proxy d'API configuré pour valider les jetons d'accès OAuth 2.0 et vérifier le quota. | VerifyAccessToken Quota |
none |
| oauth10a-3led | Montre la configuration à trois acteurs d'OAuth 1.0a. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
none |
| outbound-oauth | Utilise l'API de traduction Microsoft Azure pour traduire les tweets. Pour ce faire, il effectue un appel sortant pour obtenir un jeton d'accès OAuth, puis le met en cache à l'aide des règles de mise en cache des services d'API, en réutilisant le jeton mis en cache à chaque appel sortant. Inclut également une application de navigateur de démonstration utilisée pour appeler le proxy d'API. | AssignMessage LookupCache PopulateCache JavaScript |
api-config.js api-token-get.js translate-query.js translate-results.js |
| Affichage paginé | Pagination d'un message de réponse XML en fonction des paramètres de limite et de décalage fournis par le client | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| cache-réponse | Montre comment mettre en cache les prévisions météorologiques sur Edge pendant 10 minutes. | ResponseCache AssignMessage |
none |
| simple-python | Cet exemple montre un scénario simple consistant à joindre un script Python dans la réponse qui lui ajoute une valeur d'en-tête. |
Script (Python) | setHeader.py |
| soap | Cet exemple présente une transformation XSL qui réécrit un fichier WSDL en réponse à une requête avec le paramètre ?wsdl. | AssignMessage ExtractVariables Script (Python) XSL |
calculaddress.py fixwsdl.xsl |
| streaming | Cet exemple présente une configuration de streaming HTTP. | none | none |
| reroute-cible | montre comment utiliser JavaScript pour sélectionner dynamiquement une URL cible en fonction du contenu d'un message de requête. | ExtractVariables JavaScript |
rewriteTargetUrl.js |
| twitter-mobile-timeline | Montre comment utiliser JavaScript pour supprimer les paramètres inutiles des tweets, ce qui génère une timeline Twitter simplifiée adaptée aux appareils mobiles limités en ressources. | AssignMessage JavaScript ; |
MobileTimeline.js |
| twitter-Oembed | Transforme les réponses de chronologie (par exemple, de statuss/user_timeline.json) en une réponse oEmbed contenant les données de chronologie en contenu HTML enrichi. | AssignMessage JavaScript ; |
recherche-oembed.js |
| variables | Montre comment extraire et définir des variables basées sur le transport et le contenu des messages JSON et XML. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
| xmltojson | Convertit les données de réponse du format XML au format JSON. | XMLToJSON JSONToXML |
none |
|
|
Fichiers de schéma XML que vous pouvez utiliser comme référence lors de la configuration de proxys d'API, de règles, de produits d'API, ainsi que de profils de développeur et d'application. |
||
|
|
Contient un outil de déploiement, deploy.py, qui importe un proxy d'API dans une organisation sur Apigee Edge, puis le déploie dans l'environnement spécifié. |
||
|
|
L'outil d'instantané d'organisation récupère les paramètres de l'organisation, y compris les développeurs, les produits d'API, les hôtes virtuels, les mappages clé/valeur, etc. Il peut être utilisé pour sauvegarder les détails d'une organisation ou pour découvrir les paramètres d'une organisation. |
Apigee-127
Si vous êtes codeur, Apigee-127 vous aide à coder les proxys d'API avec Node.js et Swagger. Vous pouvez également trouver des exemples d'a127 sur GitHub: https://github.com/apigee-127/a127-samples.
Partagez votre expérience
Partagez vos expériences sur le Forum des développeurs Apigee.