Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.
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écrits 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 à acquérir des connaissances solides sur Apigee Edge ? Nous disposons d'une bibliothèque d'exemples "learn-edge" sur GitHub qui vous permettent de déployer, d'appeler et de tracer rapidement des exemples de proxys. Vous commencerez par le proxy le plus simple, puis vous passerez à des proxys qui illustrent la validation de la clé API, le quota, la mise en cache des réponses, la gestion des erreurs et plus encore.
Une fois que vous avez cloné le dépôt et configuré votre environnement (ce qui ne prend que quelques minutes), vous pouvez essayer chaque exemple en moins d'une minute. Comme chaque échantillon crée une 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'interface utilisateur 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 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
Un ensemble d'exemples est fourni pour les thèmes du livre de recettes du proxy d'API.
| Nom | Description | Types de règles | Ressources |
|---|---|---|---|
| javascript-cookbook | Illustre un simple extrait de code JavaScript 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 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 | Montre des schémas de gestion des erreurs que vous pouvez utiliser dans le code d'un appel Java. | JavaCallout | JavaError.java |
| policy-mashup-cookbook | Application complète utilisant la composition des 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 javascript-mashup, ce qui 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 sur GitHub, où les pages "readme" fournissent des descriptions détaillées des exemples. Si vous souhaitez en savoir plus sur le fonctionnement d'une règle spécifique 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 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 cookbook et des exemples de proxys dans les tableaux ci-dessus, les exemples GitHub Edge contiennent également les ressources suivantes :
| Nom | Description | Types de règles | Ressources |
|---|---|---|---|
| regex-protection | La règle de protection contre les menaces liées aux expressions régulières peut protéger vos API et microservices de 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 clé et le code secret du client de l'application 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 les 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 | Illustre 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 | Met en œuvre une simple application de 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 une route 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 des 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. |
consulter l'exemple de code |
| oauth-client-credentials | Démonstration d'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 de consulter 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 du type d'attribution de mot de passe. | OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault |
aucun |
| oauth-verify-accesstoken | Démonstration d'un proxy d'API configuré pour valider les jetons d'accès OAuth 2.0 et vérifier le quota. | 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 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é | 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 |
| response-cache | Explique comment mettre en cache les prévisions météo sur 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 lui ajoute une valeur d'en-tête. |
Script (Python) | setHeader.py |
| soap | Démonstration d'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é et adapté aux appareils mobiles aux ressources limitées. | AssignMessage Javascript |
MobileTimeline.js |
| twitter-oembed | Transforme les réponses de la timeline (par exemple, à partir de statuses/user_timeline.json) en réponse oEmbed contenant les données de la timeline sous forme de 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 des proxys d'API, des règles, des produits d'API, ainsi que des 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 de création d'instantanés 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 développeur, Apigee-127 vous permet de créer 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.