Configurações de SEO

Otimize a visibilidade da sua documentação de API nos mecanismos de busca para atrair mais desenvolvedores e usuários. O Apidog fornece recursos abrangentes de SEO que ajudam sua documentação a obter melhor classificação nos resultados de pesquisa, facilitando a descoberta das suas APIs por usuários em potencial.

Requisito de versão

A versão do Apidog deve ser ≥ 2.7.15 para acessar estes recursos de SEO.

Você pode configurar as definições de SEO em dois níveis, de acordo com suas necessidades.

Configurações de SEO em nível de página: Configure o SEO para páginas individuais, como documentação de endpoint ou arquivos Markdown.

Configurações de SEO em todo o site: Configure metadados globais de SEO, robots.txt, sitemap.xml, regras de redirecionamento e configurações de URL para todo o site de documentação.

Configurações de SEO em nível de página

Acesse as configurações de SEO em nível de página clicando no ícone SEO Settings no lado direito de qualquer documentação de endpoint ou página Markdown.

Opções de configuração

No painel de configurações de SEO, você pode configurar:

Slug da URL: Defina o caminho para a página atual. Por exemplo, defina como find-by-id; então a URL final da página se torna: https://{your-domain.com}/find-by-id.

Meta Title: O título da página da web que aparecerá nos resultados dos mecanismos de busca.

Meta Description: Uma breve descrição da página da web exibida nos resultados dos mecanismos de busca.

Keywords: Palavras-chave para ajudar a melhorar a compreensão dos mecanismos de busca.

Metadados personalizados: Adicione tags <meta> extras em formato JSON. Exemplo:

[
  {"name": "robots", "content": "noindex"},
  {"name": "twitter:card", "content": "summary_large_image"}
]

Elas serão renderizadas em HTML como:

Configurações de SEO em nível de todo o site

Ao publicar sites de documentação online, acesse "SEO Settings" para aplicar configurações de SEO em todo o site.

Metadados globais

Isso define tags <meta> padrão para todas as páginas do site de documentação. Você pode usar variáveis integradas para gerar conteúdo dinâmico. Todas as páginas herdam essa configuração, a menos que ela seja substituída pelas configurações de SEO em nível de página.

Formato de configuração:

Use um array JSON válido, por exemplo:

[
  {"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"},
  {"property": "og:description", "content": "{{DESCRIPTION}}"},
  {"property": "og:image", "content": "{{SITE_ICON}}"},
  {"name": "twitter:card", "content": "summary_large_image"},
  {"name": "description", "content": "global description information"},
  {"name": "keywords", "content": "global keywords"}
]

Elas serão renderizadas em HTML como:

Variáveis integradas compatíveis:

As seguintes variáveis integradas são compatíveis e podem ser usadas como placeholders no campo de conteúdo quando preenchidas:

Variável	Significado
`{{PAGE_TITLE}}`	Título da página atual
`{{PAGE_URL}}`	URL completa da página
`{{SITE_NAME}}`	Nome do seu site de documentação
`{{SITE_ICON}}`	URL do ícone do seu site
`{{DESCRIPTION}}`	Descrição padrão da página
`{{KEYWORDS}}`	Palavras-chave padrão da página

Prioridade:

Ordem de prioridade

Configurações de SEO em nível de página (endpoint ou página Markdown) > Metadados globais > Padrões do sistema

Arquivo Robots (robots.txt)

Este arquivo controla o comportamento dos crawlers e fica acessível em https://{your-domain.com}/robots.txt.

Conteúdo padrão:

User-Agent: *
Allow: /

Sitemap: {{SITEMAP_URL}}

{{SITEMAP_URL}} é substituído automaticamente pela URL real do sitemap.xml, desde que o recurso de sitemap esteja habilitado.

Se estiver desabilitado, esta linha será removida automaticamente.

Como impedir que páginas sejam indexadas:

Bloquear a indexação de todo o site

Adicione o seguinte aos Metadados globais:

{"name": "robots", "content": "noindex"}

Ou impeça que mecanismos de busca rastreiem o site adicionando o seguinte ao robots.txt no nível raiz:

Bloquear a indexação de uma única página

Adicione o seguinte aos Metadados personalizados da página específica:

{"name": "robots", "content": "noindex"}

Arquivo Sitemap (sitemap.xml)

Quando habilitado, o sistema gera automaticamente um sitemap.xml listando todas as páginas do site para ajudar os mecanismos de busca a rastrearem o conteúdo de forma mais eficaz. Você pode acessar o sitemap por meio de https://{your-domain.com}/sitemap.xml.

Status padrão: habilitado.

Se desabilitado, o sitemap.xml não estará mais disponível e Sitemap: {{SITEMAP_URL}} também será removido do robots.txt.

Regras de redirecionamento da documentação

Se você modificar URLs de documentação publicadas, poderá definir regras de redirecionamento para evitar erros 404 quando os usuários visitarem URLs antigas.

Você pode adicionar manualmente várias regras de redirecionamento para encaminhar automaticamente os usuários de URLs antigas para novas URLs:

Regras de URL e slug

Clique em project settings para visualizar as regras de URL padrão das páginas do seu site.

Há dois tipos de regras de nomenclatura de URL, dependendo de um slug personalizado (URL) estar definido na página.

Quando o slug da URL está definido

O sistema usa o slug fornecido como caminho de acesso:

Por exemplo, se o slug em um arquivo Markdown for api-overview, o endereço será:

Quando o slug da URL está em branco

Escolha a regra que melhor se ajusta às preferências de SEO da sua equipe e ao fluxo de trabalho da documentação.

Referência comum de metadados

Referência de metadados

[
  {
    "name": "robots",
    "content": "noindex"
  },
  {
    "name": "charset",
    "content": "UTF-8"
  },
  {
    "name": "viewport",
    "content": "width=device-width, initial-scale=1.0"
  },
  {
    "name": "description",
    "content": "Page description"
  },
  {
    "name": "keywords",
    "content": "keyword1, keyword2, keyword3"
  },
  {
    "name": "author",
    "content": "Author Name"
  },
  {
    "name": "googlebot",
    "content": "index, follow"
  },
  {
    "name": "google",
    "content": "notranslate"
  },
  {
    "name": "google-site-verification",
    "content": "verification_token"
  },
  {
    "name": "generator",
    "content": "Mintlify"
  },
  {
    "name": "theme-color",
    "content": "#000000"
  },
  {
    "name": "color-scheme",
    "content": "light dark"
  },
  {
    "name": "format-detection",
    "content": "telephone=no"
  },
  {
    "name": "referrer",
    "content": "origin"
  },
  {
    "name": "refresh",
    "content": "30"
  },
  {
    "name": "rating",
    "content": "general"
  },
  {
    "name": "revisit-after",
    "content": "7 days"
  },
  {
    "name": "language",
    "content": "en"
  },
  {
    "name": "copyright",
    "content": "Copyright 2024"
  },
  {
    "name": "reply-to",
    "content": "email@example.com"
  },
  {
    "name": "distribution",
    "content": "global"
  },
  {
    "name": "coverage",
    "content": "Worldwide"
  },
  {
    "name": "category",
    "content": "Technology"
  },
  {
    "name": "target",
    "content": "all"
  },
  {
    "name": "HandheldFriendly",
    "content": "True"
  },
  {
    "name": "MobileOptimized",
    "content": "320"
  },
  {
    "name": "apple-mobile-web-app-capable",
    "content": "yes"
  },
  {
    "name": "apple-mobile-web-app-status-bar-style",
    "content": "black"
  },
  {
    "name": "apple-mobile-web-app-title",
    "content": "App Title"
  },
  {
    "name": "application-name",
    "content": "App Name"
  },
  {
    "name": "msapplication-TileColor",
    "content": "#000000"
  },
  {
    "name": "msapplication-TileImage",
    "content": "path/to/tile.png"
  },
  {
    "name": "msapplication-config",
    "content": "path/to/browserconfig.xml"
  },
  {
    "name": "og:title",
    "content": "Open Graph Title"
  },
  {
    "name": "og:type",
    "content": "website"
  },
  {
    "name": "og:url",
    "content": "https://example.com"
  },
  {
    "name": "og:image",
    "content": "https://example.com/image.jpg"
  },
  {
    "name": "og:description",
    "content": "Open Graph Description"
  },
  {
    "name": "og:site_name",
    "content": "Site Name"
  },
  {
    "name": "og:locale",
    "content": "en_US"
  },
  {
    "name": "og:video",
    "content": "https://example.com/video.mp4"
  },
  {
    "name": "og:audio",
    "content": "https://example.com/audio.mp3"
  },
  {
    "name": "twitter:card",
    "content": "summary"
  },
  {
    "name": "twitter:site",
    "content": "@username"
  },
  {
    "name": "twitter:creator",
    "content": "@username"
  },
  {
    "name": "twitter:title",
    "content": "Twitter Title"
  },
  {
    "name": "twitter:description",
    "content": "Twitter Description"
  },
  {
    "name": "twitter:image",
    "content": "https://example.com/image.jpg"
  },
  {
    "name": "twitter:image:alt",
    "content": "Image Description"
  },
  {
    "name": "twitter:player",
    "content": "https://example.com/player"
  },
  {
    "name": "twitter:player:width",
    "content": "480"
  },
  {
    "name": "twitter:player:height",
    "content": "480"
  },
  {
    "name": "twitter:app:name:iphone",
    "content": "App Name"
  },
  {
    "name": "twitter:app:id:iphone",
    "content": "12345"
  },
  {
    "name": "twitter:app:url:iphone",
    "content": "app://"
  },
  {
    "name": "article:published_time",
    "content": "2024-01-01T00:00:00+00:00"
  },
  {
    "name": "article:modified_time",
    "content": "2024-01-02T00:00:00+00:00"
  },
  {
    "name": "article:expiration_time",
    "content": "2024-12-31T00:00:00+00:00"
  },
  {
    "name": "article:author",
    "content": "Author Name"
  },
  {
    "name": "article:section",
    "content": "Technology"
  },
  {
    "name": "article:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "book:author",
    "content": "Author Name"
  },
  {
    "name": "book:isbn",
    "content": "1234567890"
  },
  {
    "name": "book:release_date",
    "content": "2024-01-01"
  },
  {
    "name": "book:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "profile:first_name",
    "content": "John"
  },
  {
    "name": "profile:last_name",
    "content": "Doe"
  },
  {
    "name": "profile:username",
    "content": "johndoe"
  },
  {
    "name": "profile:gender",
    "content": "male"
  },
  {
    "name": "music:duration",
    "content": "205"
  },
  {
    "name": "music:album",
    "content": "Album Name"
  },
  {
    "name": "music:album:disc",
    "content": "1"
  },
  {
    "name": "music:album:track",
    "content": "1"
  },
  {
    "name": "music:musician",
    "content": "Artist Name"
  },
  {
    "name": "music:song",
    "content": "Song Name"
  },
  {
    "name": "music:song:disc",
    "content": "1"
  },
  {
    "name": "music:song:track",
    "content": "1"
  },
  {
    "name": "video:actor",
    "content": "Actor Name"
  },
  {
    "name": "video:actor:role",
    "content": "Role Name"
  },
  {
    "name": "video:director",
    "content": "Director Name"
  },
  {
    "name": "video:writer",
    "content": "Writer Name"
  },
  {
    "name": "video:duration",
    "content": "120"
  },
  {
    "name": "video:release_date",
    "content": "2024-01-01"
  },
  {
    "name": "video:tag",
    "content": "tag1, tag2, tag3"
  },
  {
    "name": "video:series",
    "content": "Series Name"
  }
]

Configurações de SEO

Configurações de SEO em nível de página#

Opções de configuração#

Configurações de SEO em nível de todo o site#

Metadados globais#

Arquivo Robots (robots.txt)#

Arquivo Sitemap (sitemap.xml)#

Regras de redirecionamento da documentação#

Regras de URL e slug#

Referência comum de metadados#

Configurações de SEO em nível de página

Opções de configuração

Configurações de SEO em nível de todo o site

Metadados globais

Arquivo Robots (robots.txt)

Arquivo Sitemap (sitemap.xml)

Regras de redirecionamento da documentação

Regras de URL e slug

Referência comum de metadados