Documentation Index

Fetch the complete documentation index at: https://docs.document360.com/llms.txt

Use this file to discover all available pages before exploring further.

Clause de non-responsabilité: Cet article a été généré par traduction automatique.

Dépannage des problèmes de rendu API et d’affichage

Prev Next

Stylisation HTML incorrecte dans la réponse API

Quand cela se produit : Lors de la récupération du contenu HTML de l’article via l’API, la sortie affichée s’affiche avec un style brisé ou des guillemets mal placés.

Pourquoi cela arrive : Les réponses API sont formatées en JSON, qui utilise des caractères d’échappement (par exemple, \") pour gérer certains caractères en toute sécurité. Si ces caractères échappés ne sont pas convertis en retour (non échappés) avant le rendu, la structure HTML se casse.

Par exemple, un paragraphe comme :

<p>This is a "sample" paragraph.</p>

Peut apparaître dans la réponse JSON comme suit :

"<p>This is a \"sample\" paragraph.</p>"

Comment le corriger :

  1. Récupérez le contenu HTML via l’API et inspectez la réponse.
  2. Cherchez des personnages évadés dans la réponse JSON, tels que :
    • \" (guillemets doubles échappés)
    • \\ (coups de mâle échappés)
    • \n (nouvelle ligne)
    • \t (tab)
  3. Dégagez le contenu JSON avant de le rendre officiellement. Cela restaure la structure HTML originale.
  4. Vérifiez le style après avoir détaché pour vous assurer que le contenu est correct.
  5. Si le problème persiste, vérifiez si des modifications supplémentaires dans votre code modifient la réponse de l’API.
    JSON Escape and Unescape tool with highlighted buttons for user interaction.
    Une fois correctement débarrassé, le HTML s’affichera comme prévu, évitant ainsi les écarts de style.

Les variables et extraits ne s’affichent pas dans la réponse API

Quand cela se produit : Lors de la récupération du contenu de l’article via l’API, les variables apparaissent comme des espaces réservés non traités — par exemple, {{variable.UserName}} au lieu de la valeur réelle.

Pourquoi cela arrive : Le isForDisplay paramètre n’est pas correctement défini dans la requête API.

  • Lorsque isForDisplay = true: variables et extraits sont entièrement rendus dans la réponse, et les placeholders sont remplacés par des valeurs réelles.
  • Quand isForDisplay = false (ou non défini) : la réponse contient des placeholders non traités, qui ne conviennent pas à l’affichage direct.
    Comment le corriger :
  1. Récupérez le contenu de l’article via l’API et inspectez la réponse.
  2. Vérifiez si des variables ou des extraits semblent non traités dans la réponse.
  3. Assurez-vous que la requête API inclut "isForDisplay": true. Exemple de demande :
   {
     "articleId": "your-article-id",
     "isForDisplay": true
   }
  1. Envoyez la requête modifiée et vérifiez que la réponse API affiche désormais correctement les variables et extraits rendus.
  2. Si le problème persiste, assurez-vous que le système traitant la réponse API gère et affiche correctement le contenu rendu.

IMPORTANT
Lors de la mise à jour des articles via l’API, ne renvoyez pas le contenu entièrement rendu. Cela remplacerait les placeholders dynamiques par des valeurs statiques, cassant ainsi le rendu futur.