Création d'une page produit dans API Gateway - Amazon API Gateway
ConsidérationsCréation d'une page produit

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création d'une page produit dans API Gateway

Une page produit aide les consommateurs à comprendre et à utiliser vos produits. La documentation se situe au niveau du produit, de sorte que tous les portails qui incluent votre produit disposent de cette documentation. API Gateway prend en charge deux types de pages de produits rédigées en GitHub Flavored Markdown :

Page Présentation

Lorsque vous créez votre produit, API Gateway génère automatiquement une page de présentation de votre produit en fonction des informations que vous fournissez lors de la création de votre produit. Cette page comporte une mise en forme supplémentaire qui ne peut pas être modifiée. Vous pouvez modifier le texte ou supprimer la page du produit portail.

Pages personnalisées

Une page personnalisée est une page écrite en Markdown. Vous pouvez consulter cette section pour consulter les conditions générales ou suivre un didacticiel sur l'utilisation de votre produit. Vous pouvez transformer n'importe quelle page personnalisée en page d'aperçu. Lorsque vous transformez une page personnalisée en page d'aperçu, le contenu de la page est mis en forme pour correspondre à la page d'aperçu.

Considérations

Les considérations suivantes peuvent avoir une incidence sur votre utilisation des pages de produits :

  • Cette documentation n'est pas au niveau de l'API et n'inclut aucune méthode, aucune ressource ou aucun paramètre de demande. Pour savoir comment modifier la documentation au niveau de l'API d'un produit, consultez. Mettre à jour le point de terminaison REST d'un produit dans API Gateway

  • Vous ne pouvez pas charger directement un .md fichier sur votre produit.

  • Vous pouvez modifier l'ordre des pages de produits en modifiant la liste des pages dans l'ordre d'affichage de votre produit de portail. Pour de plus amples informations, veuillez consulter Mettre à jour un produit de portail dans API Gateway.

  • Vous devez republier tous les portails qui incluent votre produit pour que les modifications apportées à la documentation prennent effet.

  • Si plusieurs portails utilisent le même produit de portail, les pages de produits sont les mêmes sur tous les portails. Pour avoir les mêmes points de terminaison REST mais des pages de produit différentes, créez plusieurs produits.

Création d'une page produit

La procédure suivante indique comment créer une page produit.

Pour créer une page produit

  1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

  2. Dans le volet de navigation principal, sélectionnez Portal products.

  3. Choisissez un produit.

  4. Sous Documentation, choisissez Créer une page personnalisée.

  5. Pour Titre de page, entrez le titre de la page.

  6. Pour Body, entrez votre documentation supplémentaire à l'aide de GitHub Flavored Markdown.

    La section Aperçu montre comment votre contenu apparaît sur un portail. Le style visuel final peut changer en fonction des paramètres de votre portail.

  7. Choisissez Créer une page de produit.

  8. Votre page produit est désormais un brouillon. Choisissez Brouillon de pages de documentation, puis choisissez votre page produit pour finaliser le contenu de la page.

  9. Choisissez Modifier la page.

  10. Dans Nom de section, entrez un nom ou choisissez une section existante. Lorsque vous ajoutez votre page produit à une section, les consommateurs peuvent consulter votre contenu sur un portail publié.

  11. Sélectionnez Enregistrer les modifications.

Pour que la nouvelle page soit visible par les consommateurs, vous devez tout de même republier votre portail. Pour de plus amples informations, veuillez consulter Publier un portail dans API Gateway.