Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
Les exemples d'API Apigee Edge contiennent des exemples de proxys d'API, de règles, de code et d'outils qui illustrent les fonctionnalités des services d'API Apigee Edge décrites ci-dessous.
Pour savoir comment utiliser les exemples, consultez Utiliser les exemples de proxy d'API.
Apprenez par la pratique
Vous souhaitez vous lancer rapidement et commencer à constituer une base de connaissances solide sur Apigee Edge ? Nous disposons d'une bibliothèque d'exemples "learn-edge" sur GitHub qui vous permet de déployer, d'appeler et de suivre rapidement des exemples de proxys, en commençant par le proxy le plus simple et en passant ensuite aux proxys qui illustrent la validation de la clé API, les quotas, le cache de réponse, la gestion des erreurs, 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. Étant donné que chaque échantillon crée une nouvelle révision du même proxy, votre environnement ne sera pas encombré par de nombreux échantillons. Vous pouvez changer de révision, redéployer une autre révision dans l'UI de gestion et consulter le code du proxy à tout moment. Le fichier "readme" de chaque exemple vous donne également un bref aperçu de ce qu'il fait et de la façon dont il est configuré.
Essayez-la ! https://github.com/apigee/api-platform-samples/tree/master/learn-edge
Exemples de livres de recettes de documentation
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 | Présente un extrait 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. | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | Application JavaScript complète qui appelle des API publiques, combine des 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 policy-mashup, ce qui montre que le même problème peut être résolu à l'aide de différentes techniques.) | JavaScript | MashItUp.js |
| java-hello | Appel Java "Hello World" simple. | 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 un appel Java. | JavaCallout | JavaProperties.java |
| java-error | Présente les modèles de gestion des erreurs que vous pouvez utiliser dans le code d'un appel Java. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | Application complète qui utilise la composition de règles pour appeler deux API publiques, combiner des résultats et générer 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 proxies d'API suivants se trouvent sur GitHub, où les pages de documentation fournissent des descriptions détaillées des exemples. Si vous souhaitez savoir comment une stratégie particulière fonctionne dans un exemple, recherchez-la dans la colonne "Types de stratégies" ci-dessous, puis cliquez sur le nom de l'exemple dans la colonne "Nom". (Les règles sont associées à leurs pages de référence respectives dans la documentation.)
Documentation de référence et outils
En plus des exemples de documentation et des exemples de proxys des tableaux ci-dessus, les exemples GitHub d'Edge contiennent également les ressources suivantes:
| Nom | Description | Types de règles | Ressources |
|---|---|---|---|
| regex-protection | La règle de protection contre les menaces d'expression régulière peut protéger vos API et microservices backend 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é client de l'application et le secret sur Edge avant d'appeler un fournisseur d'identité externe pour valider les identifiants de l'utilisateur. | OAuthV2, autres | N/A |
| condition-pattern-matching | Ce proxy vous permet d'essayer et de tester facilement des instructions conditionnelles dans un flux de proxy d'API. | AssignMessage | N/A |
| access-entity | Explique comment récupérer des profils d'entités à partir du datastore Apigee Edge. | AssignMessage AccessEntity ExtractVariables |
aucun |
| apikey | Implémente une validation simple des clés API | VerifyAPIKey AssignMessage Quota |
aucun |
| async-callout | Présente un appel asynchrone simple à l'aide de httpClient JavaScript. | 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 |
| conditional-policy | Implémente une simple application des règles conditionnelles. Lorsqu'une requête contient un en-tête HTTP responsetime:true, une règle exécute un script Python qui ajoute un ensemble de métriques de performances au message de réponse en tant qu'en-têtes HTTP. | Script (Python) | timer.py |
| dynamic-endpoint | Implémente un routage conditionnel simple dans un scénario légèrement plus complexe, qui définit deux URL et un routage par défaut. | aucun | aucun |
| 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 à partir de Jira. | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-mediation | Cet exemple montre comment effectuer une médiation des identifiants Kerberos sur Apigee Edge. | JavaCallout | Fichier JAR Java |
| oauth-advanced | Exemple complet et fonctionnel du flux de type d'attribution de code d'autorisation, avec Apigee Edge comme serveur d'autorisation. |
GenerateAccessToken et bien d'autres… |
voir l'exemple de code |
| oauth-client-credentials | Présente un point de terminaison de jeton OAuth 2.0 entièrement fonctionnel configuré pour le type d'attribution des identifiants client. | GenerateAccessToken | aucun |
| oauth-login-app | Obsolète. Nous vous recommandons plutôt d'examiner l'exemple oauth-advanced. | ||
| oauth-validate-key-secret | Illustre une technique permettant de valider la clé et le secret du client avant d'appeler un fournisseur d'identité pour valider les identifiants utilisateur dans le flux de type d'autorisation par mot de passe. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
aucun |
| oauth-verify-accesstoken | Présente un proxy d'API configuré pour valider les jetons d'accès OAuth 2.0 et vérifier les quotas. | VerifyAccessToken Quota |
aucun |
| oauth10a-3led | Montre la configuration à trois acteurs d'OAuth 1.0a. | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
aucun |
| outbound-oauth | Utilise l'API de traduction de Microsoft Azure pour traduire des tweets. Pour ce faire, il effectue un appel sortant pour obtenir un jeton d'accès OAuth, puis met en cache le jeton à l'aide des règles de mise en cache des services d'API, en réutilisant le jeton mis en cache chaque fois qu'un appel sortant est effectué. Il 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é | Permet de paginer 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 |
| response-cache | Explique comment mettre en cache les prévisions météo dans Edge pendant 10 minutes. | ResponseCache AssignMessage |
aucun |
| simple-python | Illustre un scénario simple d'association d'un script Python dans la réponse qui y ajoute une valeur d'en-tête. |
Script (Python) | setHeader.py |
| soap | Illustre une transformation XSL qui réécrit un fichier WSDL en réponse à une requête avec le paramètre de requête ?wsdl. | AssignMessage ExtractVariables Script (Python) XSL |
calculateaddress.py fixwsdl.xsl |
| streaming | Démonstration d'une configuration de streaming HTTP. | aucun | aucun |
| target-reroute | 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 permet d'obtenir un flux Twitter simplifié adapté aux appareils mobiles à ressources limitées. | AssignMessage JavaScript |
MobileTimeline.js |
| twitter-oembed | Transforme les réponses de la chronologie (par exemple, à partir de statuses/user_timeline.json) en réponse oEmbed contenant les données de la chronologie en tant que contenu HTML enrichi. | AssignMessage JavaScript |
search-oembed.js |
| variables | Montre comment extraire et définir les variables en fonction du contenu des messages JSON et XML et du transport. | AssignMessage ExtractVariables XMLToJSON |
minimize.js |
| xmltojson | Convertit les données de réponse du format XML au format JSON. | XMLToJSON JSONToXML |
aucun |
|
|
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é de l'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 permet de commencer à coder des proxys d'API avec Node.js et Swagger. Vous trouverez également des exemples 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.