Redirecciones

Las redirecciones envían a los usuarios desde URL antiguas a nuevas. Úsalas cuando reorganices la documentación, renombres páginas o mantengas enlaces de versiones anteriores de la documentación.

Configuración

Agrega redirecciones a tu docs.json:

{
  "redirects": [
    {
      "source": "/old-page",
      "destination": "/new-page"
    },
    {
      "source": "/guides/setup",
      "destination": "/getting-started"
    }
  ]
}

Tipos de redirección

Coincidencia exacta

Redirige una URL específica:

{
  "source": "/api/v1/users",
  "destination": "/api/v2/users"
}

/api/v1/users → /api/v2/users

Coincidencia con comodín

Usa * para coincidir con segmentos de ruta:

{
  "source": "/blog/*",
  "destination": "/articles/*"
}

/blog/hello-world → /articles/hello-world

Coincidencia por prefijo

Redirige todas las rutas bajo un prefijo:

{
  "source": "/v1/*",
  "destination": "/v2/*"
}

/v1/api/users → /v2/api/users

Códigos de estado HTTP

Por defecto, las redirecciones devuelven un 308 (redirección permanente). Especifica un estado diferente:

{
  "source": "/old-page",
  "destination": "/new-page",
  "statusCode": 307
}

Usa 308 para la mayoría de las redirecciones de documentación. Usa 307 para movimientos temporales durante migraciones.

Patrones comunes

Reorganizar la documentación

Al reestructurar la navegación:

{
  "redirects": [
    { "source": "/setup", "destination": "/getting-started" },
    { "source": "/setup/install", "destination": "/getting-started/installation" },
    { "source": "/setup/config", "destination": "/getting-started/configuration" }
  ]
}

Migración de versión de API

Al deprecar una versión de API:

{
  "redirects": [
    { "source": "/api/v1/*", "destination": "/api/v2/*" }
  ]
}

Redirecciones externas

Redirige a URL externas:

{
  "source": "/community",
  "destination": "https://discord.gg/your-server"
}

Preservar el SEO

Cuando las páginas tienen posicionamiento en buscadores existente:

{
  "redirects": [
    {
      "source": "/tutorials/getting-started-with-api",
      "destination": "/quickstart",
      "statusCode": 301
    }
  ]
}

Orden de las redirecciones

Las redirecciones se evalúan en orden. Las reglas más específicas deben ir antes que los comodines:

{
  "redirects": [
    { "source": "/api/v1/special-endpoint", "destination": "/api/special" },
    { "source": "/api/v1/*", "destination": "/api/v2/*" }
  ]
}

Gana la primera regla que coincida.

Limitaciones

• Las redirecciones solo se aplican a rutas de documentación
• Los parámetros de consulta se preservan automáticamente
• Los fragmentos hash se preservan automáticamente
• Máximo 1000 redirecciones por proyecto

Probar las redirecciones

Después de agregar redirecciones:

1. Despliega los cambios
2. Visita la URL antigua directamente
3. Verifica que llegues al nuevo destino
4. Comprueba el código de estado HTTP en las herramientas de desarrollo del navegador

# Check redirect with curl
curl -I https://docs.example.com/old-page

¿Qué sigue?