Cada artigo endpoint no seu espaço de trabalho de documentação da API vem com um conjunto de opções para adicionar conteúdo personalizado, configurar configurações de artigos, colaborar com sua equipe e controlar o acesso. Este artigo cobre tudo o que está disponível em uma página de artigo de endpoint.
Adicionando conteúdo personalizado a artigos de endpoint
Você pode adicionar e formatar conteúdo personalizado diretamente nas páginas endpoint da API usando o editor embutido. Isso é útil para adicionar notas de uso, exemplos de código ou contexto que não está registrado na sua especificação OpenAPI.
Para adicionar conteúdo a uma página de endpoint:
- Navegue até a documentação da API ({ }) na barra de navegação da esquerda.
- Abra o artigo de endpoint que você quer editar.
- Clique no ícone (+) para inserir um bloco de editor abaixo do conteúdo gerado pela especificação.
- Insira seu conteúdo e formate-o usando as opções da barra de ferramentas.
Seu conteúdo é salvo automaticamente. Qualquer conteúdo personalizado que você adicionar é mantido quando você regenera ou ressincroniza a documentação da API.
Barra de ferramentas do editor
O editor de artigos de endpoint suporta opções básicas de formatação - negrito, itálico e sublinhado, além da possibilidade de inserir um link, anexar um arquivo ou incorporar uma imagem. Essas opções estão disponíveis na barra de ferramentas no topo do bloco editor.
Conteúdo personalizado adicionado às páginas endpoint é mantido quando você regenera ou ressincroniza a documentação da API.
Configurações do artigo
Cada artigo endpoint possui um painel de configurações de artigo acessível pelo ícone (⋯) na barra de navegação superior do editor. Isso lhe dá acesso a opções adicionais de configuração para o artigo.
Como cada uma dessas configurações possui seu próprio artigo dedicado, esta seção oferece uma breve visão geral e links para a documentação relevante.
| Ambientação | O que ele faz |
|---|---|
| Lembrete de avaliação | Defina um lembrete para revisar o artigo em intervalos específicos, seja marcando para revisão ou agendando um lembrete. |
| Campos personalizados | Adicione campos de metadados personalizados ao artigo. |
| GEO/SEO | Configure as configurações de SEO, incluindo meta-título, descrição e geosegmentação. |
| Visibilidade na busca | Controle se o artigo aparece nos resultados de busca. |
| Tags | Adicione tags ao artigo para melhor descoberta. |
| Selos | Aplique rótulos para categorizar e filtrar artigos. |
| Artigos relacionados | Linke artigos relacionados que os leitores possam achar úteis. |
| Imagem em destaque | Defina uma imagem em destaque para o artigo. |
| Anexos | Adicione anexos ao artigo. |
| Indicador de status | Defina um indicador de status para sinalizar o estado do artigo. |
| Preferências | Configure preferências em nível de artigo. |
| Tipo de editor | Alterne entre os tipos de editor do artigo. |
| Marque como obsoleto | Marque o artigo como desatualizado para sinalizar que ele não está mais sendo mantido ativamente. |
Para instruções detalhadas sobre cada configuração, consulte o artigo sobre gestão de artigos .
Opções de artigos para endpoint
Clicar com o botão direito em um artigo endpoint no painel Categorias & Artigos te dá as seguintes opções:
| Opção | O que ele faz |
|---|---|
| Publicar | Publique o artigo sobre o endpoint no site da base de conhecimento. |
| Publicar depois | Agende a publicação do artigo em uma data e horário específicos. |
| Renomeação | Renomeie o artigo do endpoint. |
| Segurança | Configure quem pode acessar o artigo tanto pelo portal quanto pelo site da Base de Conhecimento. |
Discussões
O painel de discussão permite que você converse diretamente com sua equipe em um artigo endpoint. Isso é útil para deixar feedback, sinalizar problemas ou coordenar atualizações sem deixar a documentação.
Para abrir o painel de Discussão, clique no ícone de Discussão na barra de navegação superior do editor. Você pode iniciar uma nova conversa e usar @ para mencionar um membro específico da equipe.
FAQ
O conteúdo personalizado é mantido quando ressincronizo a documentação da minha API?
Sim. Qualquer conteúdo personalizado que você adiciona aos artigos de endpoint é mantido quando você regenera ou ressincroniza a documentação da API. Apenas o conteúdo gerado pela especificação é atualizado.
Posso baixar artigos em PDF usando a API?
Atualmente, não há opção para baixar artigos em PDF pelos endpoints da API.
O que acontece com o conteúdo personalizado quando um endpoint é excluído durante a resincronização?
Quando um endpoint é removido da sua especificação e uma ressincronização é executada, o artigo do endpoint e todo o seu conteúdo personalizado são permanentemente excluídos. Endpoints excluídos são movidos para a lixeira, onde podem ser visualizados por até 30 dias, mas não podem ser restaurados.