Gestione degli errori

Ultimo aggiornamento: 16 luglio 2024
  • Argomenti:

Creato per:

  • Sviluppatore

Quando si verifica un problema durante una chiamata all’API di Reactor, può essere restituito un errore in uno dei seguenti modi:

  • Errori immediati: quando si esegue una richiesta che genera un errore immediato, l’API restituisce una risposta di errore, con lo stato HTTP che riflette il tipo generale di errore che si è verificato.
  • Errori ritardati: quando si esegue una richiesta API che causa un errore ritardato (ad esempio un’attività asincrona), l’API potrebbe restituire un errore in meta.status_details di una risorsa correlata.

Formato degli errori

Le risposte di errore mirano a conformarsi alle specifiche degli errori JSON:API e in genere si attengono alla seguente struttura:

{
  "errors": [
    {
      "id": "8a5526da-ab12-4be9-b084-2efe537f388c",
      "status": "404",
      "code": "not-found",
      "title": "Record Not Found",
      "meta": {
        "request_id": "jfb0dQ2e0XVTkQ6AOfEJFfTDjguw9x3d"
      },
      "source": {
        "pointer": "/data"
      }
    }
  ]
}
ProprietàDescrizione
idIdentificatore univoco per questa particolare occorrenza del problema.
statusCodice di stato HTTP applicabile a questo problema, espresso come valore stringa.
codeCodice di errore specifico per l’applicazione, espresso come valore stringa.
titleRiepilogo breve e leggibile del problema, che non deve cambiare da occorrenza a occorrenza, a meno che non sia a scopo di localizzazione.
detailSpiegazione leggibile specifica per questa occorrenza del problema. Come title, il valore di questo campo può essere localizzato.
source

Oggetto contenente riferimenti all’origine dell’errore, facoltativamente con uno o più dei seguenti membri:

  • pointer: una stringa JSON Pointer (RFC6901) che fa riferimento all’entità associata nel documento della richiesta (ad esempio /data per un oggetto dati principale o /data/attributes/title per un attributo specifico).
metaOggetto contenente metadati non standard sull’errore.