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.

Haftungsausschluss: Dieser Artikel wurde durch maschinelle Übersetzung erstellt.

Fehlerbehebung bei API-Rendering und Anzeigeproblemen

Prev Next

Falsches HTML-Styling in der API-Antwort

Wenn es eintritt: Beim Abrufen von Artikel-HTML-Inhalten über die API werden die gerenderten Ausgaben mit defektem Styling oder falsch platzierten Anführungszeichen angezeigt.

Warum es passiert: API-Antworten sind in JSON formatiert, das Escape-Zeichen (zum Beispiel ) \"verwendet, um bestimmte Zeichen sicher zu handhaben. Wenn diese entgangenen Zeichen vor dem Rendern nicht zurück (unentscaped) konvertiert werden, bricht die HTML-Struktur.

Zum Beispiel ein Absatz wie:

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

Kann in der JSON-Antwort erscheinen als:

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

Wie man es behebt:

  1. Rufen Sie den HTML-Inhalt über die API ab und überprüfen Sie die Antwort.
  2. Suchen Sie in der JSON-Antwort nach entkommenen Charakteren, zum Beispiel:
    • \" (entkommen doppelte Anführungszeichen)
    • \\ (entkommene Rückschläge)
    • \n (Zeilenzeile)
    • \t (Tab)
  3. Entscape den JSON-Inhalt, bevor du ihn renderst. Dies stellt die ursprüngliche HTML-Struktur wieder her.
  4. Überprüfe das Styling nach dem Unescape, um sicherzustellen, dass der Inhalt korrekt erscheint.
  5. Wenn das Problem weiterhin besteht, prüfen Sie, ob weitere Änderungen in Ihrem Code die API-Antwort verändern.
    JSON Escape and Unescape tool with highlighted buttons for user interaction.
    Sobald das HTML ordnungsgemäß unescaped ist, wird es wie erwartet angezeigt und verhindert so Stilabweichungen.

Variablen und Schnipsel werden in der API-Antwort nicht gerendert

Wenn es eintritt: Beim Abrufen von Artikelinhalten über die API erscheinen Variablen als unverarbeitete Platzhalter – zum Beispiel {{variable.UserName}} anstelle des tatsächlichen Werts.

Warum es passiert: Der Parameter isForDisplay ist in der API-Anfrage nicht korrekt gesetzt.

  • Wenn isForDisplay = true: Variablen und Schnipsel vollständig in der Antwort gerendert werden, und Platzhalter werden durch tatsächliche Werte ersetzt.
  • Wenn isForDisplay = false (oder nicht gesetzt): Die Antwort enthält unverarbeitete Platzhalter, die nicht für die direkte Anzeige geeignet sind.
    Wie man es behebt:
  1. Rufen Sie den Artikelinhalt über die API ab und prüfen Sie die Antwort.
  2. Überprüfe, ob Variablen oder Schnipsel in der Antwort unverarbeitet erscheinen.
  3. Stellen Sie sicher, dass die API-Anfrage enthält "isForDisplay": true. Beispielwunsch:
   {
     "articleId": "your-article-id",
     "isForDisplay": true
   }
  1. Senden Sie die modifizierte Anfrage und überprüfen Sie, ob die API-Antwort nun korrekt gerenderte Variablen und Snippets anzeigt.
  2. Wenn das Problem weiterhin besteht, stellen Sie sicher, dass das System, das die API-Antwort verarbeitet, den gerenderten Inhalt korrekt behandelt und darstellt.

WICHTIG
Beim Aktualisieren von Artikeln über die API sollten vollständig gerenderte Inhalte nicht zurückgegeben werden. Dies würde dynamische Platzhalter durch statische Werte ersetzen und das zukünftige Rendering beeinträchtigen.