Reindirizzamenti

I reindirizzamenti inviano i lettori dagli URL vecchi a quelli nuovi. Usali quando riorganizzi la documentazione, rinomini le pagine o vuoi mantenere funzionanti i link delle versioni precedenti.

Configurazione

Aggiungi i reindirizzamenti al tuo docs.json:

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

Tipi di reindirizzamento

Corrispondenza esatta

Reindirizza un URL specifico:

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

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

Corrispondenza con caratteri jolly

Usa * per corrispondere ai segmenti del percorso:

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

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

Corrispondenza del prefisso

Reindirizza ogni percorso sotto un prefisso:

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

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

Codici di stato HTTP

I reindirizzamenti restituiscono 308 (reindirizzamento permanente) per impostazione predefinita. Imposta uno stato diverso:

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

Usa 308 per la maggior parte dei reindirizzamenti della documentazione. Usa 307 per gli spostamenti temporanei durante le migrazioni.

Pattern comuni

Riorganizzazione della documentazione

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

Migrazione della versione dell'API

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

Reindirizzamenti esterni

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

Conservazione della SEO

Mantieni il posizionamento nei motori di ricerca delle pagine spostate con un reindirizzamento permanente:

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

Ordine dei reindirizzamenti

I reindirizzamenti vengono valutati in ordine. Inserisci le regole specifiche prima dei jolly:

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

Vince la prima regola corrispondente.

Limitazioni

• I reindirizzamenti si applicano solo ai percorsi della documentazione
• I parametri di query vengono preservati automaticamente
• I frammenti hash vengono preservati automaticamente
• Massimo 1000 reindirizzamenti per progetto

Test dei reindirizzamenti

1. Esegui il deploy delle modifiche
2. Visita direttamente il vecchio URL
3. Verifica che tu arrivi alla nuova destinazione
4. Controlla il codice di stato HTTP negli strumenti di sviluppo del browser

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

Prossimi passi?