Redirections

Les redirections redirigent les utilisateurs d'anciennes URL vers de nouvelles. Utilisez-les lors de la réorganisation de la documentation, du renommage de pages ou du maintien de liens provenant de versions précédentes de la documentation.

Configuration

Ajoutez des redirections à votre docs.json :

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

Types de redirections

Correspondance exacte

Redirige une URL spécifique :

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

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

Correspondance avec joker

Utilisez * pour correspondre aux segments de chemin :

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

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

Correspondance par préfixe

Redirigez tous les chemins sous un préfixe :

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

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

Codes de statut HTTP

Par défaut, les redirections renvoient un 308 (redirection permanente). Spécifiez un statut différent :

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

Utilisez 308 pour la plupart des redirections de documentation. Utilisez 307 pour les déplacements temporaires lors des migrations.

Patterns courants

Réorganisation de la documentation

Lors de la restructuration de votre navigation :

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

Migration de version d'API

Lors de la dépréciation d'une version d'API :

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

Redirections externes

Redirigez vers des URL externes :

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

Préservation du SEO

Lorsque des pages ont des classements de recherche existants :

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

Ordre des redirections

Les redirections sont évaluées dans l'ordre. Les règles plus spécifiques doivent précéder les jokers :

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

La première règle correspondante l'emporte.

Limitations

• Les redirections s'appliquent uniquement aux chemins de documentation
• Les paramètres de requête sont préservés automatiquement
• Les fragments hash sont préservés automatiquement
• Maximum 1000 redirections par projet

Test des redirections

Après avoir ajouté des redirections :

1. Déployez vos modifications
2. Visitez directement l'ancienne URL
3. Vérifiez que vous arrivez sur la nouvelle destination
4. Vérifiez le code de statut HTTP dans les outils de développement du navigateur

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

Prochaines étapes