Configuración de SEO

Optimice la visibilidad de su documentación de API en motores de búsqueda para atraer a más desarrolladores y usuarios. Apidog proporciona funciones SEO completas que ayudan a que su documentación se posicione mejor en los resultados de búsqueda, lo que facilita que los usuarios potenciales descubran sus API.

Requisito de versión

La versión de Apidog debe ser ≥ 2.7.15 para acceder a estas funciones SEO.

Puede configurar los ajustes de SEO en dos niveles según sus necesidades.

Configuración de SEO a nivel de página: Configure el SEO para páginas individuales, como documentación de endpoint o archivos Markdown.

Configuración de SEO para todo el sitio: Configure metadatos SEO globales, robots.txt, sitemap.xml, reglas de redirección y ajustes de URL para todo el sitio de documentación.

Configuración de SEO a nivel de página

Acceda a la configuración de SEO a nivel de página haciendo clic en el icono SEO Settings situado en el lado derecho de cualquier documentación de endpoint o página Markdown.

Opciones de configuración

En el panel de configuración de SEO, puede configurar:

Slug de URL: Defina la ruta para la página actual. Por ejemplo, establézcala como find-by-id; entonces la URL final de la página será: https://{your-domain.com}/find-by-id.

Metatítulo: El título de la página web que aparecerá en los resultados de los motores de búsqueda.

Metadescripción: Una breve descripción de la página web que se muestra en los resultados de los motores de búsqueda.

Palabras clave: Palabras clave para ayudar a mejorar la comprensión por parte de los motores de búsqueda.

Metadatos personalizados: Añada etiquetas <meta> adicionales en formato JSON. Ejemplo:

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

Estas se renderizarán en HTML como:

Configuración de SEO a nivel de todo el sitio

Al publicar sitios de documentación en línea, vaya a "SEO Settings" para aplicar configuraciones SEO a todo el sitio.

Metadatos globales

Esto establece etiquetas <meta> predeterminadas para cada página del sitio de documentación. Puede usar variables integradas para generar contenido dinámico. Todas las páginas heredan esta configuración, a menos que se sobrescriba mediante la configuración de SEO a nivel de página.

Formato de configuración:

Utilice un arreglo JSON válido, por ejemplo:

[
  {"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 se renderizarán en HTML como:

Variables integradas compatibles:

Las siguientes variables integradas son compatibles y pueden utilizarse como marcadores de posición en el campo de contenido cuando se rellena:

Variable	Significado
`{{PAGE_TITLE}}`	Título de la página actual
`{{PAGE_URL}}`	URL completa de la página
`{{SITE_NAME}}`	Nombre de su sitio de documentación
`{{SITE_ICON}}`	URL del icono de su sitio
`{{DESCRIPTION}}`	Descripción predeterminada de la página
`{{KEYWORDS}}`	Palabras clave predeterminadas de la página

Prioridad:

Orden de prioridad

Page-Level SEO Settings (endpoint or Markdown page) > Global Metadata > System defaults

Archivo Robots (robots.txt)

Este archivo controla el comportamiento de los rastreadores y es accesible en https://{your-domain.com}/robots.txt.

Contenido predeterminado:

User-Agent: *
Allow: /

Sitemap: {{SITEMAP_URL}}

{{SITEMAP_URL}} se reemplaza automáticamente por la URL real de sitemap.xml, siempre que la función de sitemap esté habilitada.

Si está deshabilitada, esta línea se elimina automáticamente.

Cómo evitar que las páginas sean indexadas:

Bloquear la indexación de todo el sitio

Añada lo siguiente a Global Metadata:

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

O impida que los motores de búsqueda rastreen el sitio añadiendo lo siguiente al robots.txt de nivel raíz:

Bloquear la indexación de una sola página

Añada lo siguiente a los Custom Metadata de la página específica:

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

Archivo Sitemap (sitemap.xml)

Cuando está habilitado, el sistema genera automáticamente un sitemap.xml que enumera todas las páginas del sitio para ayudar a que los motores de búsqueda rastreen de forma más eficaz. Puede acceder al sitemap mediante https://{your-domain.com}/sitemap.xml.

Estado predeterminado: habilitado.

Si está deshabilitado, sitemap.xml dejará de estar disponible y Sitemap: {{SITEMAP_URL}} también se eliminará de robots.txt.

Reglas de redirección de documentación

Si modifica las URL de la documentación publicada, puede establecer reglas de redirección para evitar errores 404 cuando los usuarios visiten URL antiguas.

Puede añadir manualmente varias reglas de redirección para reenviar automáticamente a los usuarios desde URL antiguas a nuevas:

Reglas de URL y slug

Haga clic en project settings para ver las reglas de URL predeterminadas para las páginas de su sitio.

Existen dos tipos de reglas de nomenclatura de URL, dependiendo de si se establece un slug personalizado (URL) en la página.

Cuando el slug de URL está establecido

El sistema utiliza el slug proporcionado como ruta de acceso:

Por ejemplo, si el slug en un archivo Markdown es api-overview, la dirección será:

Cuando el slug de URL está en blanco

Elija la regla que mejor se adapte a las preferencias de SEO de su equipo y al flujo de trabajo de documentación.

Referencia de metadatos comunes

Referencia de metadatos

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

Configuración de SEO

Configuración de SEO a nivel de página#

Opciones de configuración#

Configuración de SEO a nivel de todo el sitio#

Metadatos globales#

Archivo Robots (robots.txt)#

Archivo Sitemap (sitemap.xml)#

Reglas de redirección de documentación#

Reglas de URL y slug#

Referencia de metadatos comunes#

Configuración de SEO a nivel de página

Opciones de configuración

Configuración de SEO a nivel de todo el sitio

Metadatos globales

Archivo Robots (robots.txt)

Archivo Sitemap (sitemap.xml)

Reglas de redirección de documentación

Reglas de URL y slug

Referencia de metadatos comunes