Vous avez peut-être passé beaucoup de temps à perfectionner la documentation de votre API, mais lorsque vous recherchez des mots-clés associés dans les moteurs de recherche, votre documentation apparaît rarement dans les résultats. Le problème n'est pas un contenu de mauvaise qualité, mais un manque d'optimisation SEO essentielle pour votre site de documentation.
Les sites de documentation en ligne publiés d'Apidog sont livrés par défaut avec une gamme d'optimisations SEO intégrées, notamment la génération de sitemaps, la gestion des fichiers robots, les URL sémantiques et les balises de métadonnées personnalisables pour chaque page. Tous ces éléments sont essentiels pour que les moteurs de recherche explorent et indexent efficacement votre contenu.
Au-delà de ces paramètres par défaut, vous pouvez affiner les réglages SEO pour répondre à vos besoins spécifiques. Les fonctionnalités sont divisées en deux niveaux : les paramètres au niveau de la page et les paramètres au niveau du site. Les paramètres au niveau de la page vous permettent d'optimiser des points d'accès individuels (endpoints) ou des documents Markdown, tandis que les paramètres au niveau du site offrent une gestion unifiée pour l'ensemble de votre site de documentation.
Plongeons dans les détails. Si votre version d'Apidog est obsolète, nous vous recommandons de la mettre à jour vers la dernière version (cliquez sur le bouton de téléchargement ci-dessous).
Configuration des paramètres SEO au niveau de la page dans Apidog
Les paramètres SEO au niveau de la page vous permettent d'optimiser la façon dont chaque point d'accès (endpoint) ou page de documentation Markdown apparaît dans les moteurs de recherche. C'est simple à configurer et peut améliorer considérablement la visibilité et les taux de clics.
Comment configurer les paramètres SEO au niveau de la page
Étape 1 : Ouvrez la page que vous souhaitez optimiser
Naviguez vers le point d'accès (endpoint) ou la page de documentation Markdown souhaité(e) dans votre projet.
Étape 2 : Cliquez sur l'icône des paramètres SEO
Recherchez l'icône SEO Settings (Paramètres SEO) en haut à droite de la page. Cliquez dessus pour ouvrir le panneau de configuration.
Étape 3 : Définissez un slug d'URL personnalisé
Par défaut, les URL des pages de documentation sont générées par le système avec une chaîne de chiffres (par exemple, https://votre-domaine.com/5702007m0), ce qui n'est ni lisible ni favorable au SEO.
Vous pouvez saisir un slug d'URL significatif "find-pet-by-id" pour le point d'accès "Find pet by ID", et l'URL devient : https://votre-domaine.com/find-pet-by-id. Cela rend l'URL plus claire et plus facile à retenir.
Étape 4 : Modifiez le méta-titre et la méta-description
Méta-titre : C'est le titre bleu affiché dans les résultats de recherche. Un titre clair et riche en mots-clés améliore le classement et encourage les clics.
Méta-description : Ce texte peut apparaître sous votre titre dans les résultats de recherche. Bien que les moteurs de recherche la génèrent parfois automatiquement, une description bien rédigée aide les utilisateurs à comprendre rapidement le contenu de la page.
Étape 5 : Ajoutez des mots-clés pertinents (facultatif)
Bien que les moteurs de recherche s'appuient moins sur les méta-mots-clés aujourd'hui, leur ajout peut toujours signaler le sujet de la page. Par exemple, pour le point d'accès "Find pet by ID", voici quelques mots-clés que vous pourriez vouloir ajouter : pet info, per store endpoint, pet data, REST API
Étape 6 : Insérez des métadonnées personnalisées (Option avancée)
Pour un contrôle SEO avancé, vous pouvez définir des balises meta personnalisées en utilisant du JSON.
Exemple:
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://your-domain.com/assets/image.png"}]Celles-ci seront rendues sous forme de balises <meta> standard dans le HTML et peuvent contrôler l'indexation ou l'apparence de la page lorsqu'elle est partagée sur les réseaux sociaux.
Configuration des paramètres SEO au niveau du site dans Apidog
Au-delà des paramètres SEO pour une seule page, Apidog offre une configuration SEO complète au niveau du site pour vous aider à gérer les métadonnées, les règles d'indexation et les redirections d'URL sur l'ensemble de votre site de documentation.
Vous pouvez accéder à ces paramètres lors de la publication de votre documentation sous :
Partager les Docs → Publier les Sites de Docs → Paramètres SEO
1. Configurer les métadonnées globales
Utilisez Global Metadata (Métadonnées globales) pour définir des balises meta qui s'appliquent à toutes les pages de documentation. Cela assure une cohérence de marque et améliore le SEO sans dupliquer le travail sur chaque page. Vous pouvez configurer les métadonnées globales comme ceci :
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]Vous pouvez utiliser des variables intégrées comme :
{{PAGE_TITLE}}{{PAGE_URL}}{{SITE_NAME}}{{SITE_ICON}}{{DESCRIPTION}}{{KEYWORDS}}
⚠️ Règles de priorité : Les paramètres SEO au niveau de la page remplacent les Métadonnées globales, qui remplacent les Paramètres système par défaut.
2. Gérer robots.txt
Le fichier robots.txt donne des instructions aux moteurs de recherche sur les pages à explorer. Apidog génère automatiquement un fichier robots.txt de base qui permet à tous les robots d'accéder à toutes les pages et pointe vers le fichier sitemap.
Si vous souhaitez empêcher certaines pages d'être indexées, ajoutez simplement {"name": "robots", "content": "noindex"} dans les Métadonnées globales ou les paramètres SEO au niveau de la page.
3. Activer ou désactiver sitemap.xml
La fonctionnalité sitemap.xml est activée par défaut car elle représente un énorme avantage SEO. Ce fichier (également connu sous le nom de "plan du site") est comme un répertoire de votre site, listant toutes les URL de page. Les robots des moteurs de recherche l'utilisent pour indexer systématiquement et efficacement votre contenu. Une fois activé, il est accessible à l'adresse https://{votre-domaine.com}/sitemap.xml.
Si vous devez désactiver cette fonctionnalité, le système arrêtera de générer le sitemap et mettra automatiquement à jour robots.txt pour supprimer la référence au sitemap.
4. Configurer les règles de redirection des Docs pour éviter les erreurs 404
Si vous modifiez l'URL d'un document publié (par exemple, pour l'optimisation SEO), utilisez les Docs Redirect Rules (Règles de redirection des Docs) pour préserver le trafic et le classement dans les moteurs de recherche. En configurant des règles de redirection, les utilisateurs visitant l'ancienne URL sont automatiquement envoyés vers la nouvelle.
Comment configurer les redirections :
1. Allez dans la section Docs Redirect Rules (Règles de redirection des Docs) dans le panneau des Paramètres SEO.
2. Ajoutez une règle spécifiant l'ancienne URL et la nouvelle URL.
Cela garantit que les utilisateurs et les moteurs de recherche sont automatiquement envoyés vers la bonne page sans rencontrer d'erreur 404.
Stratégies de nommage des URL dans Apidog
Pour les paramètres d'URL, le système utilise différentes stratégies selon que vous définissez une URL personnalisée ou non. Si vous le faites, le système utilise directement votre valeur – par exemple, si vous définissez api-overview, l'adresse finale est https://{votre-domaine.com}/api-overview.
Si vous ne définissez pas d'URL personnalisée, il existe deux règles d'auto-génération :
- Règle 1 : Titre + ID. par exemple,
https://{votre-domaine.com}/SEO-Settings-5702007m0. Cela combine des informations sémantiques avec l'unicité, aidant à la fois les moteurs de recherche et les utilisateurs à comprendre la page. - Règle 2 : ID uniquement. par exemple,
https://{votre-domaine.com}/5702007m0. C'est plus simple mais moins descriptif.
Du point de vue du SEO, utiliser des mots-clés dans vos URL est généralement le meilleur choix – les moteurs de recherche tiennent compte des mots-clés dans les URL lors du classement des pages. Cela dit, si votre site de documentation possède déjà une forte autorité de domaine, l'utilisation d'URL riches en mots-clés ou "sémantiques" devient moins importante.
Pour la plupart des sites web, inclure des mots-clés dans l'URL est une bonne pratique. Cependant, si vous préférez des URL plus propres ou si la structure de votre documentation est complexe, l'utilisation d'URL simplifiées ou générées par le système est également une option valide.
Conseils pratiques pour configurer le SEO de la documentation API
Pour rendre la documentation de votre API plus visible dans les résultats de recherche, suivez ces bonnes pratiques SEO étape par étape :
1. Commencez par les paramètres SEO globaux
Commencez par configurer les métadonnées globales – telles qu'un méta-titre, une description et des mots-clés par défaut. Cela crée une base SEO cohérente sur l'ensemble de votre site de documentation, garantissant que chaque page couvre les bases.
2. Priorisez les pages clés pour le SEO au niveau de la page
Ensuite, identifiez vos pages les plus importantes – comme les points d'accès (endpoints) fréquemment utilisés, les guides d'intégration ou les tutoriels de démarrage rapide. Ce sont les pages vers lesquelles vous souhaitez diriger le plus de trafic.
Pour chacune d'elles, personnalisez :
- Méta-titre : Rendez-le clair et riche en mots-clés.
- Méta-description : Résumez le contenu de la page de manière concise.
- Mots-clés : Ajoutez des termes pertinents que les utilisateurs pourraient rechercher.
3. Choisissez la bonne structure d'URL
Lorsque vous définissez les règles d'URL :
- Utilisez des URL incluant le titre (par exemple,
/get-user-data) si votre équipe accorde de l'importance au SEO et souhaite améliorer la découvrabilité. - Utilisez des URL contenant uniquement l'ID (par exemple,
/123456abc) si vous préférez la simplicité ou si vous avez une structure de documentation complexe.
4. Comprenez que le SEO est un jeu de longue haleine
Même avec des paramètres on-page parfaits, le SEO prend du temps. Le classement dans les moteurs de recherche dépend de :
- L'autorité de domaine de votre site
- Les liens retour (backlinks) provenant d'autres sources fiables
- L'engagement et le comportement des utilisateurs
- La fréquence d'exploration par les moteurs de recherche
Ne vous attendez pas à des résultats immédiats – soyez patient.
5. Améliorez continuellement en vous basant sur les données
Surveillez régulièrement les performances SEO :
- Voyez quelles pages reçoivent du trafic et lesquelles n'en reçoivent pas.
- Recueillez les commentaires des utilisateurs.
- Mettez à jour les pages faibles avec un contenu plus clair et de meilleures métadonnées.
Conclusion
Apidog fournit une boîte à outils SEO complète pour aider la documentation de votre API à mieux se classer dans les moteurs de recherche. Vous pouvez affiner des pages individuelles ou gérer les paramètres SEO sur l'ensemble de votre site – le tout en un seul endroit.
Les fonctionnalités clés incluent :
- URL personnalisées pour des liens plus propres et riches en mots-clés
- Méta-titres et descriptions pour une meilleure visibilité dans les recherches
- Génération de sitemaps pour aider les moteurs de recherche à explorer votre site
- Règles de redirection pour gérer les mises à jour de contenu sans perdre de valeur SEO
Que vous apportiez de petites modifications au niveau de la page ou que vous configuriez des paramètres globaux, Apidog a tout ce dont vous avez besoin pour optimiser votre documentation pour la recherche.
Pour plus de détails, consultez la section Paramètres SEO dans la documentation d'aide d'Apidog.
Si vous souhaitez en savoir plus sur l'optimisation pour les moteurs de recherche, consultez :