Es posible que hayas dedicado mucho tiempo a perfeccionar la documentación de tu API, pero cuando buscas palabras clave relacionadas en los motores de búsqueda, tus documentos rara vez aparecen en los resultados. El problema no es el contenido deficiente, sino la falta de optimización SEO esencial para tu sitio de documentación.
Los sitios de documentación online publicados de Apidog vienen con una serie de optimizaciones SEO integradas por defecto, incluyendo la generación de sitemaps, la gestión de archivos robots, URLs semánticas y etiquetas de metadatos personalizables para cada página. Todos estos elementos son fundamentales para que los motores de búsqueda rastreen e indexen tu contenido de manera efectiva.
Más allá de estas configuraciones predeterminadas, puedes ajustar la configuración de SEO para satisfacer tus necesidades específicas. Las funciones se dividen en dos niveles: configuración a nivel de página y configuración a nivel de sitio. La configuración a nivel de página te permite optimizar endpoints individuales o documentos Markdown, mientras que la configuración a nivel de sitio proporciona una gestión unificada para todo tu sitio de documentación.
Profundicemos en los detalles. Si tu versión de Apidog está desactualizada, te recomendamos actualizar a la última versión primero (haz clic en el botón de descarga a continuación).
Configuración de SEO a Nivel de Página dentro de Apidog
La configuración de SEO a nivel de página te permite optimizar cómo aparece cada endpoint o página de documentación Markdown en los motores de búsqueda. Es fácil de configurar y puede mejorar significativamente la visibilidad y las tasas de clics.
Cómo Configurar los Ajustes de SEO a Nivel de Página
Paso 1: Abre la Página que Quieres Optimizar
Navega al endpoint o página de documentación Markdown deseada en tu proyecto.
Paso 2: Haz Clic en el Icono de Configuración de SEO
Busca el icono de SEO Settings (Configuración de SEO) en la parte superior derecha de la página. Haz clic en él para abrir el panel de configuración.
Paso 3: Establece un Slug de URL Personalizado
Por defecto, las URLs de las páginas de documentación son generadas por el sistema con una cadena de números (por ejemplo, https://your-domain.com/5702007m0), las cuales no son legibles ni amigables para el SEO.
Puedes introducir un slug de URL significativo como "find-pet-by-id" para el endpoint "Find pet by ID", y la URL se convertirá en: https://your-domain.com/find-pet-by-id. Esto hace que la URL sea más clara y fácil de recordar.
Paso 4: Edita el Meta Título y la Meta Descripción
Meta Título: Este es el titular azul que se muestra en los resultados de búsqueda. Un título claro y rico en palabras clave mejora el ranking y fomenta los clics.
Meta Descripción: Este texto puede aparecer debajo de tu título en los resultados de búsqueda. Aunque los motores de búsqueda a veces lo generan automáticamente, una descripción bien redactada ayuda a los usuarios a comprender rápidamente el contenido de la página.
Paso 5: Añade Palabras Clave Relevantes (Opcional)
Aunque los motores de búsqueda dependen menos de las meta palabras clave hoy en día, añadirlas aún puede señalar el tema de la página. Por ejemplo, para el endpoint "Find pet by ID", aquí tienes algunas palabras clave que podrías querer añadir: información mascota, endpoint tienda mascotas, datos mascotas, API REST
Paso 6: Inserta Metadatos Personalizados (Opción Avanzada)
Para un control de SEO avanzado, puedes definir meta etiquetas personalizadas usando JSON.
Ejemplo:
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://your-domain.com/assets/image.png"}]Estas se renderizarán como etiquetas <meta> estándar en el HTML y pueden controlar la indexación o cómo aparece la página cuando se comparte en redes sociales.
Configuración de SEO a Nivel de Sitio dentro de Apidog
Más allá de la configuración de SEO de una sola página, Apidog ofrece una configuración de SEO completa a nivel de sitio para ayudarte a gestionar metadatos, reglas de indexación y redireccionamientos de URL en todo tu sitio de documentación.
Puedes acceder a esta configuración al publicar tu documentación en:
Share Docs → Publish Docs Sites → SEO Settings (Compartir Documentos → Publicar Sitios de Documentación → Configuración de SEO)
1. Configurar Metadatos Globales
Usa Global Metadata (Metadatos Globales) para definir meta etiquetas que se apliquen a todas las páginas de documentación. Esto asegura una marca consistente y mejora el SEO sin duplicar el trabajo en cada página. Puedes configurar los metadatos globales así:
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]Puedes usar variables integradas como:
{{PAGE_TITLE}}(Título de la Página){{PAGE_URL}}(URL de la Página){{SITE_NAME}}(Nombre del Sitio){{SITE_ICON}}(Icono del Sitio){{DESCRIPTION}}(Descripción){{KEYWORDS}}(Palabras Clave)
⚠️ Reglas de Prioridad: La configuración de SEO a nivel de página anula los Metadatos globales, los cuales anulan los Valores predeterminados del sistema.
2. Gestionar robots.txt
El archivo robots.txt da instrucciones a los motores de búsqueda sobre qué páginas rastrear. Apidog genera automáticamente un robots.txt básico que permite a todos los rastreadores acceder a todas las páginas y apunta al archivo sitemap.
Si quieres evitar que ciertas páginas sean indexadas, simplemente añade {"name": "robots", "content": "noindex"} en los Metadatos globales o en la configuración de SEO a nivel de página.
3. Habilitar o Deshabilitar sitemap.xml
La función sitemap.xml está habilitada por defecto porque es un gran impulso para el SEO. Este archivo (también conocido como "el mapa del sitio") es como un directorio de tu sitio, listando todas las URLs de las páginas. Los rastreadores de motores de búsqueda lo utilizan para indexar tu contenido de manera sistemática y eficiente. Una vez habilitado, es accesible en https://{your-domain.com}/sitemap.xml.
Si necesitas deshabilitar esta función, el sistema dejará de generar el sitemap y actualizará automáticamente robots.txt para eliminar la referencia al sitemap.
4. Configurar Reglas de Redireccionamiento de Documentos para Evitar Errores 404
Si cambias la URL de un documento publicado (por ejemplo, para optimización SEO), usa Docs Redirect Rules (Reglas de Redireccionamiento de Documentos) para preservar el tráfico y el ranking en los motores de búsqueda. Al configurar reglas de redireccionamiento, los usuarios que visitan la URL antigua son enviados automáticamente a la nueva.
Cómo Configurar Redireccionamientos:
1. Ve a la sección Docs Redirect Rules (Reglas de Redireccionamiento de Documentos) en el panel de Configuración de SEO.
2. Añade una regla especificando la URL antigua y la URL nueva.
Esto asegura que tanto los usuarios como los motores de búsqueda sean enviados automáticamente a la página correcta sin encontrarse con un error 404.
Estrategias de Nomenclatura de URL en Apidog
Para la configuración de URLs, el sistema utiliza diferentes estrategias dependiendo de si configuras una URL personalizada. Si lo haces, el sistema utiliza tu valor directamente—por ejemplo, si se establece como api-overview, la dirección final es https://{your-domain.com}/api-overview.
Si no configuras una URL personalizada, hay dos reglas de auto-generación:
- Regla 1: Título + ID. Por ejemplo,
https://{your-domain.com}/SEO-Settings-5702007m0. Esto combina información semántica con unicidad, ayudando tanto a los motores de búsqueda como a los usuarios a entender la página. - Regla 2: Solo ID. Por ejemplo,
https://{your-domain.com}/5702007m0. Esto es más simple pero menos descriptivo.
Desde la perspectiva del SEO, usar palabras clave en tus URLs es generalmente la mejor opción—los motores de búsqueda sí consideran las palabras clave de la URL al clasificar las páginas. Dicho esto, si tu sitio de documentación ya tiene una fuerte autoridad de dominio, usar URLs ricas en palabras clave o "semánticas" se vuelve menos importante.
Para la mayoría de los sitios web, incluir palabras clave en la URL es una buena práctica. Sin embargo, si prefieres URLs más limpias o la estructura de tu documentación es compleja, usar URLs simplificadas o generadas por el sistema también es una opción válida.
Consejos Prácticos para Configurar el SEO de la Documentación de API
Para que la documentación de tu API sea más visible en los resultados de búsqueda, sigue estas mejores prácticas de SEO paso a paso:
1. Comienza con la Configuración Global de SEO
Empieza configurando los metadatos globales, como un meta título, descripción y palabras clave predeterminados. Esto crea una base de SEO consistente en todo tu sitio de documentación, asegurando que cada página tenga lo básico cubierto.
2. Prioriza las Páginas Clave para el SEO a Nivel de Página
Luego, identifica tus páginas más importantes, como endpoints de uso frecuente, guías de incorporación o tutoriales de inicio rápido. Estas son las páginas a las que quieres dirigir la mayor parte del tráfico.
Para cada una de ellas, personaliza:
- Meta Título: Hazlo claro y rico en palabras clave.
- Meta Descripción: Resume el contenido de la página de forma concisa.
- Palabras Clave: Añade términos relevantes que los usuarios podrían buscar.
3. Elige la Estructura de URL Correcta
Al establecer reglas de URL:
- Usa URLs que incluyan el título (por ejemplo,
/obtener-datos-usuario) si tu equipo valora el SEO y quiere mejorar la visibilidad. - Usa URLs que solo incluyan el ID (por ejemplo,
/123456abc) si prefieres la simplicidad o tienes una estructura de documentación compleja.
4. Entiende que el SEO es un Juego a Largo Plazo
Incluso con una configuración en página perfecta, el SEO lleva tiempo. El ranking de búsqueda depende de:
- La autoridad de dominio de tu sitio
- Los backlinks de otras fuentes confiables
- La participación y el comportamiento del usuario
- La frecuencia de rastreo por los motores de búsqueda
No esperes resultados inmediatos, sé paciente.
5. Mejora Continuamente Basándote en Datos
Monitorea regularmente el rendimiento del SEO:
- Observa qué páginas reciben tráfico y cuáles no.
- Recopila comentarios de los usuarios.
- Actualiza las páginas débiles con contenido más claro y mejores metadatos.
Conclusión
Apidog proporciona un conjunto de herramientas de SEO completo para ayudar a que la documentación de tu API se clasifique mejor en los motores de búsqueda. Puedes ajustar páginas individuales o gestionar la configuración de SEO en todo tu sitio, todo en un solo lugar.
Las características clave incluyen:
- URLs personalizadas para enlaces más limpios y ricos en palabras clave
- Meta títulos y descripciones para una mejor visibilidad en la búsqueda
- Generación de Sitemap para ayudar a los motores de búsqueda a rastrear tu sitio
- Reglas de redireccionamiento para gestionar actualizaciones de contenido sin perder valor SEO
Ya sea que estés realizando pequeñas ediciones a nivel de página o configurando ajustes globales, Apidog tiene todo lo que necesitas para optimizar tu documentación para la búsqueda.
Para más detalles, consulta la sección SEO Settings (Configuración de SEO) en la documentación de ayuda de Apidog.
Si quieres aprender más sobre optimización para motores de búsqueda, consulta: