Você pode ter dedicado muito tempo aperfeiçoando a documentação da sua API, mas quando pesquisa palavras-chave relacionadas em mecanismos de busca, seus documentos raramente aparecem nos resultados. O problema não é o conteúdo ruim — é a falta de otimização essencial de SEO para o site da sua documentação.
Os sites de documentação online publicados do Apidog vêm com uma variedade de otimizações de SEO integradas por padrão, incluindo geração de sitemap, gerenciamento de arquivo robots, URLs semânticas e tags de metadados personalizáveis para cada página. Tudo isso é fundamental para que os mecanismos de busca rastreiem e indexem seu conteúdo de forma eficaz.
Além desses padrões, você pode ajustar as configurações de SEO para atender às suas necessidades específicas. Os recursos são divididos em dois níveis: configurações de nível de página e configurações de nível de site. As configurações de nível de página permitem otimizar endpoints individuais ou documentos Markdown, enquanto as configurações de nível de site fornecem gerenciamento unificado para todo o site da sua documentação.
Vamos nos aprofundar nos detalhes. Se a sua versão do Apidog estiver desatualizada, recomendamos atualizar para a versão mais recente primeiro (clique no botão de download abaixo).
Configurando Configurações de SEO de Nível de Página no Apidog
As configurações de SEO de nível de página permitem otimizar como cada endpoint ou página de documentação Markdown aparece nos mecanismos de busca. É simples de configurar e pode melhorar significativamente a visibilidade e as taxas de cliques.
Como Configurar Configurações de SEO de Nível de Página
Passo 1: Abra a Página que Você Deseja Otimizar
Navegue até o endpoint desejado ou página de documentação Markdown no seu projeto.
Passo 2: Clique no Ícone de Configurações de SEO
Procure pelo ícone Configurações de SEO no canto superior direito da página. Clique nele para abrir o painel de configurações.
Passo 3: Defina um Slug de URL Personalizado
Por padrão, as URLs das páginas de documentação são geradas pelo sistema com uma sequência de números (por exemplo, https://seu-dominio.com/5702007m0), que não são legíveis nem amigáveis para SEO.
Você pode inserir um slug de URL significativo "encontrar-pet-por-id" para o endpoint "Encontrar pet por ID", e a URL se torna: https://seu-dominio.com/encontrar-pet-por-id. Isso torna a URL mais clara e fácil de lembrar.
Passo 4: Edite o Meta Título e a Meta Descrição
Meta Título: Esta é a manchete azul exibida nos resultados de busca. Um título claro e rico em palavras-chave melhora os rankings e incentiva cliques.
Meta Descrição: Este texto pode aparecer abaixo do seu título nos resultados de busca. Embora os mecanismos de busca às vezes a gerem automaticamente, uma descrição bem escrita ajuda os usuários a entender rapidamente o conteúdo da página.
Passo 5: Adicione Palavras-chave Relevantes (Opcional)
Embora os mecanismos de busca dependam menos de meta palavras-chave hoje, adicioná-las ainda pode sinalizar o tópico da página. Por exemplo, para o endpoint "Encontrar pet por ID", aqui estão algumas palavras-chave que você pode querer adicionar: informações pet, endpoint loja pet, dados pet, REST API
Passo 6: Insira Metadados Personalizados (Opção Avançada)
Para controle avançado de SEO, você pode definir meta tags personalizadas usando JSON.
Exemplo:
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://seu-dominio.com/assets/image.png"}]Estas serão renderizadas como tags <meta> padrão no HTML e podem controlar a indexação ou como a página aparece ao ser compartilhada em mídias sociais.
Configurando Configurações de SEO de Nível de Site no Apidog
Além das configurações de SEO de página única, o Apidog oferece configuração abrangente de SEO de nível de site para ajudar você a gerenciar metadados, regras de indexação e redirecionamentos de URL em todo o site da sua documentação.
Você pode acessar essas configurações ao publicar sua documentação em:
Compartilhar Docs → Publicar Sites de Docs → Configurações de SEO
1. Configurar Metadados Globais
Use Metadados Globais para definir meta tags que se aplicam a todas as páginas de documentação. Isso garante consistência de marca e melhora o SEO sem duplicar o trabalho em cada página. Você pode configurar os metadados globais assim:
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]Você pode usar variáveis integradas como:
{{PAGE_TITLE}}(Título da Página){{PAGE_URL}}(URL da Página){{SITE_NAME}}(Nome do Site){{SITE_ICON}}(Ícone do Site){{DESCRIPTION}}(Descrição){{KEYWORDS}}(Palavras-chave)
⚠️ Regras de Prioridade: As configurações de SEO de nível de página substituem os Metadados globais, que substituem os Padrões do sistema.
2. Gerenciar robots.txt
O arquivo robots.txt fornece instruções aos mecanismos de busca sobre quais páginas rastrear. O Apidog gera automaticamente um robots.txt básico que permite que todos os crawlers acessem todas as páginas e aponta para o arquivo sitemap.
Se você quiser impedir que certas páginas sejam indexadas, basta adicionar {"name": "robots", "content": "noindex"} nos Metadados globais ou nas configurações de SEO de nível de página.
3. Habilitar ou Desabilitar sitemap.xml
O recurso sitemap.xml é habilitado por padrão porque é um grande impulso para o SEO. Este arquivo (também conhecido como "mapa do site") é como um diretório do seu site, listando todas as URLs das páginas. Os crawlers de mecanismos de busca o usam para indexar seu conteúdo de forma sistemática e eficiente. Uma vez habilitado, ele é acessível em https://{seu-dominio.com}/sitemap.xml.
Se você precisar desabilitar este recurso, o sistema deixará de gerar o sitemap e atualizará automaticamente o robots.txt para remover a referência ao sitemap.
4. Configurar Regras de Redirecionamento de Docs para Evitar Erros 404
Se você alterar a URL de um documento publicado (por exemplo, para otimização de SEO), use Regras de Redirecionamento de Docs para preservar o tráfego e os rankings nos mecanismos de busca. Ao configurar regras de redirecionamento, os usuários que visitam a URL antiga são automaticamente enviados para a nova.
Como Configurar Redirecionamentos:
1. Vá para a seção Regras de Redirecionamento de Docs no painel de Configurações de SEO.
2. Adicione uma regra especificando a URL antiga e a URL nova.
Isso garante que tanto usuários quanto mecanismos de busca sejam automaticamente enviados para a página correta sem encontrar um erro 404.
Estratégias de Nomenclatura de URL no Apidog
Para as configurações de URL, o sistema usa diferentes estratégias dependendo se você define uma URL personalizada. Se você definir, o sistema usa seu valor diretamente — por exemplo, definido como api-visao-geral, o endereço final é https://{seu-dominio.com}/api-visao-geral.
Se você não definir uma URL personalizada, existem duas regras de geração automática:
- Regra 1: Título + ID. Ex:
https://{seu-dominio.com}/Configuracoes-SEO-5702007m0. Isso combina informações semânticas com exclusividade, ajudando tanto mecanismos de busca quanto usuários a entender a página. - Regra 2: Apenas ID. Ex:
https://{seu-dominio.com}/5702007m0. Esta é mais simples, mas menos descritiva.
Do ponto de vista de SEO, usar palavras-chave nas suas URLs é geralmente a melhor escolha — mecanismos de busca consideram as palavras-chave da URL ao classificar páginas. Dito isso, se o site da sua documentação já tem uma forte autoridade de domínio, usar URLs ricas em palavras-chave ou "semânticas" se torna menos importante.
Para a maioria dos sites, incluir palavras-chave na URL é uma prática recomendada. No entanto, se você preferir URLs mais limpas ou a estrutura da sua documentação for complexa, usar URLs simplificadas ou geradas pelo sistema também é uma opção válida.
Dicas Práticas para Configurar o SEO da Documentação da API
Para tornar a documentação da sua API mais visível nos resultados de busca, siga estas melhores práticas de SEO passo a passo:
1. Comece com as Configurações Globais de SEO
Comece configurando os metadados globais — como um meta título padrão, descrição e palavras-chave. Isso cria uma base de SEO consistente em todo o site da sua documentação, garantindo que cada página tenha o básico coberto.
2. Priorize Páginas Chave para SEO de Nível de Página
Em seguida, identifique suas páginas mais importantes — como endpoints frequentemente usados, guias de integração ou tutoriais de início rápido. Estas são as páginas para as quais você deseja direcionar mais tráfego.
Para cada uma delas, personalize:
- Meta Título: Torne-o claro e rico em palavras-chave.
- Meta Descrição: Resuma o conteúdo da página de forma concisa.
- Palavras-chave: Adicione termos relevantes que os usuários possam pesquisar.
3. Escolha a Estrutura de URL Certa
Ao definir regras de URL:
- Use URLs com título incluído (por exemplo,
/obter-dados-usuario) se sua equipe valoriza SEO e deseja melhorar a descoberta. - Use URLs apenas com ID (por exemplo,
/123456abc) se você preferir simplicidade ou tiver uma estrutura de documentação complexa.
4. Entenda que SEO é um Jogo de Longo Prazo
Mesmo com configurações on-page perfeitas, SEO leva tempo. Os rankings de busca dependem de:
- A autoridade de domínio do seu site
- Backlinks de outras fontes confiáveis
- Engajamento e comportamento do usuário
- Frequência de rastreamento pelos mecanismos de busca
Não espere resultados imediatos — seja paciente.
5. Melhore Continuamente com Base em Dados
Monitore regularmente o desempenho de SEO:
- Veja quais páginas recebem tráfego e quais não.
- Colete feedback dos usuários.
- Atualize páginas fracas com conteúdo mais claro e metadados melhores.
Conclusão
O Apidog fornece um kit de ferramentas de SEO abrangente para ajudar a documentação da sua API a ter um ranking melhor nos mecanismos de busca. Você pode ajustar páginas individuais ou gerenciar configurações de SEO em todo o seu site — tudo em um só lugar.
Os recursos principais incluem:
- URLs personalizadas para links mais limpos e ricos em palavras-chave
- Meta títulos e descrições para melhor visibilidade na busca
- Geração de sitemap para ajudar os mecanismos de busca a rastrear seu site
- Regras de redirecionamento para gerenciar atualizações de conteúdo sem perder valor de SEO
Seja fazendo pequenas edições no nível da página ou configurando definições globais, o Apidog tem tudo o que você precisa para otimizar seus documentos para busca.
Para mais detalhes, consulte a seção Configurações de SEO na documentação de ajuda do Apidog.
Se você quiser saber mais sobre otimização para mecanismos de busca, consulte: