Ajouter et modifier du contenu

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Utilisez le type de contenu "Page de base" de Drupal pour ajouter de la documentation sur votre API, telle que des guides d'utilisation et des documents de référence sur l'API, à votre portail de services pour les développeurs, et inclure du contenu tel que des vidéos, des enregistrements d'écran ou des téléchargements de code.

La page de documentation est configurée avec quelques entrées initiales organisées dans différentes catégories telles que "Premiers pas" et "Tutoriels". La page est un point de départ que vous pouvez modifier. De cette manière, vous pouvez ajouter vos propres entrées de contenu et les organiser comme vous le souhaitez.

Ajouter la page d'accueil de la documentation

Par défaut, la page d'accueil de la documentation se trouve à l'adresse <siteURL>/documentation sur votre portail des développeurs. La page d'accueil par défaut du portail des développeurs contient un lien vers cette page dans la zone située en haut de la page d'accueil:

Vous pouvez également ajouter un lien vers la documentation sur cette page dans le menu principal du menu du portail des développeurs.

Cependant, la page d'accueil de la documentation n'existe pas par défaut. Vous devez donc créer une page sur le portail des développeurs à l'URL appropriée.

Pour ajouter la page d'accueil de la documentation à votre portail des développeurs:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > Ajouter du contenu > Page de base dans le menu d'administration de Drupal.
  3. Saisissez le titre du document (par exemple, la page d'accueil de la documentation) et le contenu de la première page.
  4. Cliquez sur Modifier le résumé pour ajouter un récapitulatif.
  5. Cliquez sur l'élément Paramètres du menu sous la section Corps.
  6. Sélectionnez Fournir un lien de menu, ajoutez le titre du lien, puis sélectionnez <Menu principal> dans l'élément parent.
    Un lien est alors ajouté au menu principal de la page d'accueil de la documentation.
  7. Cliquez sur l'élément Paramètres du chemin de l'URL sous la section "Corps".
  8. Désélectionnez Générer un alias d'URL automatique et définissez l'alias d'URL sur documentation.
    Par défaut, l'URL d'une page est <URLdusite>/content/NomPage. En définissant l'alias d'URL, vous définissez une URL explicite de la page, ici <siteURL>/documentation.
  9. Enregistrez la page.
    Un lien vers la page doit maintenant s'afficher dans la barre de menu. Le lien contenu dans la zone de la page d'accueil devrait à présent fonctionner.
    En tant qu'administrateur, vous verrez également des boutons d'administration de contenu, tels que "Afficher" et "Modifier". Les utilisateurs sans droits d'administrateur ne les verront pas.

Ajouter une page enfant à votre documentation

Lorsque vous ajoutez des pages enfants à votre documentation:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > Ajouter du contenu > Page de base dans le menu d'administration de Drupal.
  3. Saisissez le titre de la page et le contenu.
  4. Cliquez sur Modifier le résumé pour ajouter un récapitulatif.
  5. Cliquez sur l'élément settings Menu sous la section Corps.
  6. Sélectionnez Fournir un lien de menu, puis ajoutez l'élément de menu de la page d'accueil de la documentation.



    Cette opération permet d'ajouter une page active en tant qu'enfant du menu principal de la page d'accueil de la documentation.
  7. Vous devriez maintenant voir un lien vers la page dans le menu de la page d'accueil de la documentation.

Modifier une page de documentation

Pour modifier une page:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Accédez à la page du portail des développeurs.
    Vous pouvez également cliquer sur Content (Contenu) dans le menu d'administration de Drupal pour répertorier toutes vos pages et en sélectionner une.
  3. Sélectionnez l'onglet Modifier sur la page.


  4. Ouvrez un éditeur visuel en sélectionnant "Code HTML intégral" ou "Code HTML filtré" dans le menu déroulant "Format du texte" sous la section "Corps".
    Le contenu de la page doit s'afficher dans l'éditeur.
  5. Modifiez la page si nécessaire.

  6. Cliquez sur Enregistrer.

Afficher une page de documentation

Pour afficher le contenu d'un document:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Content (Contenu) dans le menu d'administration de Drupal.
  3. Sélectionnez le document que vous souhaitez afficher.

Réorganiser l'ordre des pages

Vous pouvez modifier la séquence et le niveau d'imbrication des pages dans le menu "Accueil" de la documentation.

Pour réorganiser les pages dans le menu "Accueil de la documentation" :

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Dans le menu d'administration de Drupal, sélectionnez Structure > Menus > Main menu (Structure > Menus > Menu principal).
  3. Chaque élément du menu est associé à une icône à gauche de son nom. Si ces icônes ne s'affichent pas, cliquez sur Hide rows weight (Masquer la pondération des lignes).
  4. Pour déplacer un élément, cliquez sur l’icône et faites-la glisser vers un nouvel emplacement.
    Si vous faites glisser un élément comportant des éléments enfants, ceux-ci sont également déplacés.


  5. Cliquez sur Save Configuration (Enregistrer la configuration).

Modifier des pages de pied de page

Le pied de page du portail contient trois icônes de réseaux sociaux pour Twitter, Facebook et LinkedIn, ainsi que des liens vers les URL suivantes:

  • Règles de confidentialité pour l'URL <siteURL>/privacy-policy
  • Conditions d'utilisation à l'URL <siteURL>/terms-use
  • les pages de contact correspondant à l'URL <siteURL>/contact-us ;

Modifiez ces pages pour y ajouter votre propre contenu.

Si ces pages n'existent pas, créez-les:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > Ajouter du contenu > Page de base dans le menu d'administration de Drupal.
  3. Saisissez le titre du document (par exemple, les règles de confidentialité) et le contenu de la page.
  4. Cliquez sur Modifier le résumé pour ajouter un récapitulatif.
  5. Cliquez sur l'élément Paramètres du chemin de l'URL sous la section "Corps".
  6. Sélectionnez Générer un alias d'URL automatique, puis définissez l'alias d'URL sur "Règles de confidentialité".
    Par défaut, l'URL d'une page est <URLdusite>/content/NomPage. En définissant l'alias d'URL, vous définissez une URL explicite de la page, ici <siteURL>/privacy-policy.
  7. Enregistrez la page.
  8. Répétez cette procédure pour les pages "Conditions d'utilisation" et "Contact".

Pour modifier le contenu d'une page en pied de page, telle que les règles de confidentialité, les conditions d'utilisation ou la page "Nous contacter", sur votre portail des développeurs:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Accédez à la page en cliquant sur son lien dans le pied de page. Par exemple, cliquez sur le lien Règles de confidentialité.
  3. Cliquez sur l'onglet Modifier sur la page pour ouvrir l'éditeur.
  4. Modifiez le contenu de la page Règles de confidentialité selon vos besoins.
  5. Cliquez sur Enregistrer.
  6. Répétez cette procédure pour les pages "Conditions d'utilisation" et "Contact".

Pour modifier les icônes des réseaux sociaux, telles que Twitter, Facebook et LinkedIn, sur votre portail des développeurs:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Structure > Blocs dans le menu d'administration de Drupal.
  3. Faites défiler la page "Blocages" jusqu'à ce que le bloc Pied de page par défaut sur l'ensemble du site s'affiche.
  4. Sélectionnez le lien configure correspondant au blocage du pied de page par défaut sur l'ensemble du site.
  5. Dans la zone Contenu personnalisé, effectuez un clic droit sur une icône de réseau social, puis sélectionnez Modifier le lien dans le menu contextuel. Vous pouvez également supprimer l'icône de la zone "Contenu personnalisé".
  6. Sélectionnez Enregistrer le bloc pour enregistrer vos modifications.

Ajouter un script JavaScript à une page de portail

Vous pouvez ajouter JavaScript à n'importe quelle page du portail. Le moyen le plus simple d'ajouter du code JavaScript consiste à modifier la page, puis à:

  1. Sélectionnez Plein HTML comme Format de texte.
  2. Sélectionnez le bouton Source pour modifier le code HTML source de la page.
  3. Ajoutez le code JavaScript à la page. Par exemple, pour faire apparaître une zone d'alerte lors du chargement de la page, ajoutez le code suivant:

    <script language="JavaScript">
    alert('Welcome to my page!');
    </script>

Points à prendre en compte concernant l'utilisation de JavaScript:

  • Si vous souhaitez faire référence à un fichier JavaScript, ne le faites pas dans le code source d'un nœud, car cela crée un lien statique. Utilisez plutôt du code PHP afin de créer un lien dynamique. De cette manière, si l'emplacement du fichier JavaScript change, vous n'avez pas besoin de mettre à jour toutes les pages du portail qui le référencent.
  • Si vous souhaitez inclure un fichier JavaScript, ajoutez-le au thème du portail. Ou, si elle fait partie d'un module Drupal, ajoutez-le au module.
  • Vous pouvez également utiliser la fonction drupal_add_js de Drupal pour ajouter du JavaScript dans Drupal. Pour en savoir plus, consultez la page https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.

Nous vous recommandons de vérifier que votre contenu ne contient pas de liens non fonctionnels. Par défaut, le portail des développeurs est configuré pour rechercher les liens non fonctionnels sur différents types de pages. Par exemple, les liens sont vérifiés dans les pages de base, les articles, les entrées de blog et les sujets de forum.

Pour ajouter des types de page à la vérification des liens ou en exclure:

  1. Dans le menu d'administration de Drupal, sélectionnez Modules et assurez-vous que le module Link Checker est activé.
  2. Dans le menu d'administration de Drupal, sélectionnez Configuration > Création de contenu > Vérificateur de liens.
  3. Configurez les types de contenu à analyser pour détecter d'éventuels liens non fonctionnels.

Configurer la recherche

Le portail des développeurs fournit un moteur de recherche intégré mis en œuvre par Apache Solar, qui utilise la bibliothèque de recherche Apache Lucène. Il s'agit du moteur de recherche du site, auquel l'utilisateur accède via le champ de recherche situé dans l'angle supérieur droit de toutes les pages du portail.

Les moteurs de recherche externes, tels que Google, peuvent également indexer votre portail. Le portail des développeurs vous permet de déterminer si les moteurs de recherche externes peuvent indexer votre portail.

Configurer Apache Solar

Vous pouvez configurer Apache Solar pour contrôler les types de contenu à indexer, forcer un index et effectuer des tâches de configuration supplémentaires.

Pour configurer Apache Solar :

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Dans le menu d'administration de Drupal, sélectionnez Configuration > Recherche et métadonnées > Recherche Apache Solr.
  3. Cette page vous permet de configurer Apache Solar.

Désactivation de l'indexation Google

Il est également recommandé d'indexer le contenu et de le rendre accessible aux moteurs de recherche. Par défaut, votre contenu est indexé par l'indexeur Google. Vous avez toutefois la possibilité de désactiver l'indexation Google. Cette option peut être utile si votre portail des développeurs n'est pas prêt pour une utilisation publique et si vous ne souhaitez pas que votre contenu puisse être recherché publiquement.

Pour désactiver l'indexation Google:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Modules dans le menu d'administration de Drupal.
  3. Activez le module Metatags.
  4. Cliquez sur Enregistrer la configuration.
  5. Dans le menu d'administration de Drupal, sélectionnez Configuration > Recherche et métadonnées > Métatag.
  6. Sélectionnez l'opération Remplacer pour le Type global.
  7. Cliquez sur la section Avancé pour l'ouvrir.

  8. Cochez la case Empêcher les moteurs de recherche d'indexer cette page.
  9. Cliquez sur Enregistrer.

Notez que la section "Avancé" de la page "Global" contient d'autres options liées aux moteurs de recherche. Par exemple, vous pouvez cocher une case pour empêcher les moteurs de recherche de suivre les liens d'une page. Cochez une ou plusieurs des cases ci-dessous, selon le cas.

Documenter comment enregistrer des applications

Il est important que votre documentation contienne des instructions sur la manière dont les développeurs peuvent enregistrer leurs applications sur votre portail. Vous pouvez utiliser les instructions suivantes comme point de départ. Elles expliquent comment enregistrer des applications via le portail des développeurs par défaut.

Pour configurer la manière dont les développeurs enregistrent les applications sur votre portail, consultez la section Configurer l'enregistrement des applications. Si vous modifiez le processus d'enregistrement de l'application, modifiez les exemples d'instructions ci-dessous en conséquence.

Pour enregistrer une application via le portail des développeurs par défaut:

  1. Sélectionnez Mes applications sous votre nom d'utilisateur dans le menu de connexion.
  2. Cliquez sur l'icône d'ajout (+).

  3. Saisissez les valeurs appropriées sur la page "Ajouter une application" :
    Nom de l'application Attribuez un nom unique à votre application.
    URL de rappel

    Si nécessaire, indiquez l'URL de rappel vers laquelle l'appel OAuth doit être renvoyé.

    Par défaut, cette valeur est obligatoire même si vos API n'utilisent pas OAuth. Si vos API n'utilisent pas OAuth, saisissez une valeur factice, telle que my.site.com.
    Produit Sélectionnez un ou plusieurs produits d'API..
  4. Cliquez sur Créer une application pour enregistrer l'application et générer la clé API de l'application.