Weiterleitungen

Weiterleitungen leiten Leser von alten URLs zu neuen weiter. Verwenden Sie sie, wenn Sie Dokumentation umstrukturieren, Seiten umbenennen oder Links aus früheren Dokumentationsversionen funktionsfähig halten möchten.

Konfiguration

Fügen Sie Weiterleitungen zu Ihrer docs.json hinzu:

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

Weiterleitungstypen

Exakte Übereinstimmung

Leitet eine bestimmte URL weiter:

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

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

Platzhalterübereinstimmung

Verwenden Sie *, um Pfadsegmente zu erfassen:

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

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

Präfixübereinstimmung

Leitet jeden Pfad unter einem Präfix weiter:

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

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

HTTP-Statuscodes

Weiterleitungen geben standardmäßig 308 (dauerhafte Weiterleitung) zurück. Legen Sie einen anderen Status fest:

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

Verwenden Sie 308 für die meisten Dokumentations-Weiterleitungen. Verwenden Sie 307 für temporäre Verschiebungen während Migrationen.

Häufige Muster

Neustrukturierung der Dokumentation

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

Migration der API-Version

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

Externe Weiterleitungen

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

SEO beibehalten

Behalten Sie die Suchrankings für verschobene Seiten mit einer dauerhaften Weiterleitung bei:

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

Reihenfolge der Weiterleitungen

Weiterleitungen werden in der angegebenen Reihenfolge ausgewertet. Platzieren Sie spezifische Regeln vor Wildcards:

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

Die erste passende Regel gewinnt.

Einschränkungen

• Weiterleitungen gelten nur für Dokumentationspfade
• Abfrageparameter werden automatisch beibehalten
• Hash-Fragmente werden automatisch beibehalten
• Maximal 1000 Weiterleitungen pro Projekt

Weiterleitungen testen

1. Deployen Sie Ihre Änderungen
2. Rufen Sie die alte URL direkt auf
3. Prüfen Sie, ob Sie beim neuen Ziel landen
4. Prüfen Sie den HTTP-Statuscode in den Browser-Entwicklertools

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

Wie geht es weiter?