Definições de SEO

Otimize a visibilidade da sua documentação de API nos motores de busca para atrair mais programadores e utilizadores. O Apidog fornece funcionalidades abrangentes de SEO que ajudam a sua documentação a obter uma classificação mais elevada nos resultados de pesquisa, tornando mais fácil para potenciais utilizadores descobrirem as suas APIs.

Requisito de versão

A versão do Apidog deve ser ≥ 2.7.15 para aceder a estas funcionalidades de SEO.

Pode configurar as definições de SEO em dois níveis, com base nas suas necessidades.

Definições de SEO ao nível da página: Configure o SEO para páginas individuais, como documentação de endpoint ou ficheiros Markdown.

Definições de SEO ao nível de todo o site: Configure metadados globais de SEO, robots.txt, sitemap.xml, regras de redirecionamento e definições de URL para todo o site de documentação.

Definições de SEO ao nível da página

Aceda às definições de SEO ao nível da 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 definições de SEO, pode configurar:

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

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

Meta descrição: Uma breve descrição da página web apresentada nos resultados dos motores de busca.

Palavras-chave: Palavras-chave para ajudar a melhorar a compreensão por parte dos motores de busca.

Metadados personalizados: Adicione etiquetas <meta> extra em formato JSON. Exemplo:

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

Estas serão renderizadas em HTML como:

Definições de SEO ao nível de todo o site

Ao publicar sites de documentação online, aceda a "SEO Settings" para aplicar configurações de SEO ao nível de todo o site.

Metadados globais

Isto define etiquetas <meta> predefinidas para todas as páginas no site de documentação. Pode utilizar variáveis incorporadas para gerar conteúdo dinâmico. Todas as páginas herdam esta configuração, salvo se for substituída pelas definições de SEO ao nível da página.

Formato de configuração:

Utilize uma matriz JSON válida, 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"}
]

Estas serão renderizadas em HTML como:

Variáveis incorporadas suportadas:

As seguintes variáveis incorporadas são suportadas e podem ser utilizadas como marcadores de posição no campo de conteúdo quando preenchidas:

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

Prioridade:

Ordem de prioridade

Definições de SEO ao nível da página (endpoint ou página Markdown) > Metadados globais > Predefinições do sistema

Ficheiro Robots (robots.txt)

Este ficheiro controla o comportamento dos rastreadores e está acessível em https://{your-domain.com}/robots.txt.

Conteúdo predefinido:

User-Agent: *
Allow: /

Sitemap: {{SITEMAP_URL}}

{{SITEMAP_URL}} é substituído automaticamente pelo URL real de sitemap.xml, desde que a funcionalidade de sitemap esteja ativada.

Se estiver desativada, esta linha é removida automaticamente.

Como impedir que páginas sejam indexadas:

Bloquear a indexação de todo o site

Adicione o seguinte a Metadados globais:

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

Ou impeça os motores de busca de rastrearem o site adicionando o seguinte ao robots.txt de 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"}

Ficheiro Sitemap (sitemap.xml)

Quando ativado, o sistema gera automaticamente um sitemap.xml que lista todas as páginas do site para ajudar os motores de busca a rastrearem de forma mais eficaz. Pode aceder ao sitemap através de https://{your-domain.com}/sitemap.xml.

Estado predefinido: Ativado.

Se estiver desativado, sitemap.xml deixará de estar disponível e Sitemap: {{SITEMAP_URL}} também será removido de robots.txt.

Regras de redirecionamento da documentação

Se modificar URLs de documentação publicados, pode definir regras de redirecionamento para evitar erros 404 quando os utilizadores visitarem URLs antigos.

Pode adicionar manualmente várias regras de redirecionamento para encaminhar automaticamente os utilizadores de URLs antigos para novos:

Regras de URL e slug

Clique em project settings para ver as regras de URL predefinidas para as páginas do seu site.

Existem dois tipos de regras de nomenclatura de URL, dependendo de ter sido definido ou não um slug personalizado (URL) na página.

Quando o slug de URL está definido

O sistema utiliza o slug fornecido como caminho de acesso:

Por exemplo, se o slug num ficheiro Markdown for api-overview, o endereço será:

Quando o slug de URL está em branco

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

Referência de metadados comuns

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"
  }
]

Definições de SEO ao nível da página#

Opções de configuração#

Definições de SEO ao nível de todo o site#

Metadados globais#

Ficheiro Robots (robots.txt)#

Ficheiro Sitemap (sitemap.xml)#

Regras de redirecionamento da documentação#

Regras de URL e slug#

Referência de metadados comuns#

Definições de SEO ao nível da página

Opções de configuração

Definições de SEO ao nível de todo o site

Metadados globais

Ficheiro Robots (robots.txt)

Ficheiro Sitemap (sitemap.xml)

Regras de redirecionamento da documentação

Regras de URL e slug

Referência de metadados comuns