Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'Apigee Edge.
Apigee vous recommande d'appliquer les bonnes pratiques décrites dans les sections suivantes lors de la création de votre portail.
Susciter l'intérêt de votre audience
Ajoutez du contenu qui suscite visuellement l'intérêt de votre audience et l'invite à en savoir plus. Permettez aux utilisateurs d'API d'explorer une partie de votre portail sans se connecter. Proposez une inscription en libre-service afin qu'ils puissent être rapidement opérationnels pour créer des applications à l'aide de vos API.
Permettre aux utilisateurs d'essayer vos API
Générez automatiquement la documentation interactive de l'API à partir de vos spécifications OpenAPI pour autoriser les utilisateurs à :
- S'informer sur l'API
- Envoyer une requête en direct à l'API
Afficher une réponse en direct renvoyée par l'API
Pour en savoir plus, consultez la section Publier vos API.
Traiter les parcours de formation principaux
Fournissez des exemples d'utilisation et des tutoriels pertinents pour votre audience, basés sur son niveau d'expérience. Montrez un exemple, comme une simple séquence de commandes curl ou une procédure à suivre plus élaborée.
Mettre en œuvre le référencement naturel (SEO)
Assurez-vous que votre contenu est inclus dans l'index de recherche. investissez dans le SEO afin d'améliorer votre classement dans les résultats de recherche et permettre aux internautes de trouver votre contenu.
Suivez les bonnes pratiques ci-dessous lorsque vous structurez votre contenu. Pour en savoir plus et obtenir des consignes supplémentaires concernant Google, consultez le Guide de démarrage sur le référencement naturel Google.
| Bonne pratique | Description | Avantages |
|---|---|---|
| Créer des URL conviviales | Créez des URL lisibles et faciles à comprendre. Définissez une URL de page conviviale lors de l'ajout de pages à votre portail, comme décrit dans la section Créer une page. |
|
| Fournir un nom de portail descriptif | Définissez un nom de unique et descriptif pour votre portail, comme décrit dans la section Gérer vos portails. Ce contenu sert à renseigner la balise <title> de la page d'accueil (index) de votre portail. |
|
| Faciliter la navigation sur votre site | Définissez une structure de navigation logique, comme décrit dans la section Configurer la navigation. |
|
| Utiliser une combinaison efficace d'expressions sur l'ensemble du contenu | Intégrez des mots clés à votre contenu lorsqu'il est pertinent de le faire. La prééminence d'une chaîne de mots clés sur votre page peut améliorer le classement de votre page dans les résultats de recherche. Essayez de prédire les chaînes de mots clés que les utilisateurs sont susceptibles d'utiliser pour rechercher votre contenu. Évitez le bourrage de mots clés, c'est-à-dire en insérer à outrance dans le seul but d'améliorer le classement dans les résultats de recherche. Votre site risque d'être pénalisé par les moteurs de recherche. | Les utilisateurs qui recherchent du contenu auront plus de chances d'obtenir des résultats pertinents. |
Créer une communauté de développeurs
Faites connaître votre communauté d'API sur les réseaux sociaux standards, tels que Facebook, Twitter, etc. Publiez des blogs et des forums qui favorisent la communication et l'interaction entre les développeurs de votre communauté d'API.