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.

Isenção de responsabilidade: Este artigo foi gerado usando tradução automática.

Solução de problemas de renderização e exibição de API

Prev Next

Estilo HTML incorreto na resposta da API

Quando ocorre: Ao recuperar conteúdo HTML de artigo via API, a saída renderizada aparece com estilo quebrado ou aspas mal colocadas.

Por que isso acontece: As respostas da API são formatadas em JSON, que utiliza caracteres de escape (por exemplo, \") para lidar com certos caracteres com segurança. Se esses caracteres escapados não forem convertidos de volta (não escapados) antes da renderização, a estrutura HTML quebra.

Por exemplo, um parágrafo como:

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

Pode aparecer na resposta JSON como:

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

Como consertar:

  1. Recupere o conteúdo HTML pela API e inspecione a resposta.
  2. Procure personagens fugitivos na resposta JSON, como:
    • \" (aspas duplas escapadas)
    • \\ (golpes de rejeição escapando)
    • \n (linha nova)
    • \t (tab)
  3. Desfaça o conteúdo JSON antes de renderizá-lo. Isso restaura a estrutura original do HTML.
  4. Verifique o estilo após o desescabelo para garantir que o conteúdo fique correto.
  5. Se o problema persistir, verifique se modificações adicionais no seu código estão alterando a resposta da API.
    JSON Escape and Unescape tool with highlighted buttons for user interaction.
    Uma vez liberado corretamente, o HTML será exibido como esperado, evitando discrepâncias de estilo.

Variáveis e trechos não renderizando na resposta da API

Quando ocorre: Ao recuperar o conteúdo do artigo via API, variáveis aparecem como marcadores de posição não processados — por exemplo, {{variable.UserName}} em vez do valor real.

Por que isso acontece: O isForDisplay parâmetro não está definido corretamente na solicitação da API.

  • Quando isForDisplay = true: variáveis e trechos são totalmente renderizados na resposta, e os marcadores são substituídos por valores reais.
  • Quando isForDisplay = false (ou não definido): a resposta contém marcadores não processados, que não são adequados para exibição direta.
    Como consertar:
  1. Recupere o conteúdo do artigo via API e inspecione a resposta.
  2. Verifique se variáveis ou trechos aparecem não processados na resposta.
  3. Garanta que a requisição da API inclua "isForDisplay": true. Exemplo de pedido:
   {
     "articleId": "your-article-id",
     "isForDisplay": true
   }
  1. Envie a solicitação modificada e verifique se a resposta da API agora exibe as variáveis e trechos renderizados corretamente.
  2. Se o problema persistir, certifique-se de que o sistema que processa a resposta da API trate e exiba corretamente o conteúdo renderizado.

IMPORTANTE
Ao atualizar artigos via API, não repasse conteúdo totalmente renderizado. Isso substituiria os marcadores dinâmicos por valores estáticos, quebrando a renderização futura.