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 à :
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.
Communique l'objectif de la page sous une forme lisible.
La correspondance complète ou partielle du mot clé dans l'URL de la page améliore le classement dans les résultats de recherche.
En règle générale, les URL apparaissent dans les résultats de recherche.
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.
La correspondance complète ou partielle des mots clés dans le titre améliore le classement dans les résultats de recherche.
En règle générale, le contenu des titres de vos pages s'affiche sur la première ligne des résultats de recherche.
Faciliter la navigation sur votre site
Définissez une structure de navigation logique, comme décrit dans la section Configurer la navigation.
Orientez l'utilisateur.
Aidez les utilisateurs à trouver rapidement et facilement le contenu qu'ils recherchent.
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.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/11 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/11 (UTC)."],[[["\u003cp\u003eThis page outlines best practices for building an engaging and effective developer portal using Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eCreating user-friendly URLs, descriptive portal names, and intuitive navigation are crucial for enhancing searchability and user experience.\u003c/p\u003e\n"],["\u003cp\u003eEnabling interactive API documentation with live request and response capabilities allows users to quickly understand and test your APIs.\u003c/p\u003e\n"],["\u003cp\u003eIncorporating relevant content like tutorials and use case examples, that are based on various audience levels will improve the user experience.\u003c/p\u003e\n"],["\u003cp\u003eUtilizing social media and community features such as forums and blogs will help to build a stronger developer community.\u003c/p\u003e\n"]]],[],null,["# Best practices for building your portal\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\u003cbr /\u003e\n\nApigee recommends that you apply the best practices described in the following sections when building your portal.\n\nEngage your audience\n--------------------\n\nAdd content that engages your audience visually and compels them to want to learn more. Enable API consumers to explore a portion of your portal without logging in. Provide self-service registration so they can get up and running quickly to build apps using your APIs.\n\nLet users try your APIs\n-----------------------\n\nAuto-generate interactive API documentation from your OpenAPI Specifications to enable users to:\n\n- Learn about the API\n- Send a live request to the API\n- View a live response returned from the API\n\n For more information, see [Publishing your APIs](/apigee/docs/api-platform/publish/portal/publish-apis).\n\nAddress primary learning paths\n------------------------------\n\nProvide use case examples and tutorials that are relevant to your audience and based on their level of experience. Demonstrate by example, such as a simple curl command sequence, or step through a more elaborate procedure.\n| You can learn from your internal consumers. Perform usability tests with internal consumers and revise content based on their feedback.\n\nImplement search engine optimization (SEO)\n------------------------------------------\n\nEnsure your content is searchable. Invest in SEO that improves your ranking in search results and enable users to find your content.\n\nUse the following best practices when structuring your content. For more information and additional guidelines from Google, see the [Google Search Engine Optimization Starter Guide](http://static.googleusercontent.com/media/www.google.com/en//webmasters/docs/search-engine-optimization-starter-guide.pdf).\n\nBuild a developer community\n---------------------------\n\nEmploy social media to promote your API community through standard social channels, such as Facebook, Twitter, and so on. Publish blogs and forums that foster communication and interaction among the developers in your API community."]]
