Il tipo Status
definisce un modello di errore logico adatto a diversi ambienti di programmazione, tra cui API REST e API RPC. Viene utilizzato da gRPC. Ogni messaggio Status
contiene tre dati: codice di errore, messaggio di errore e dettagli dell'errore.
Puoi trovare ulteriori informazioni su questo modello di errore e su come utilizzarlo nella guida alla progettazione delle API.
Rappresentazione JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campi | |
---|---|
code |
Il codice di stato, che deve essere un valore enum di |
message |
Un messaggio di errore rivolto agli sviluppatori, che dovrebbe essere in inglese. Qualsiasi messaggio di errore rivolto all'utente deve essere localizzato e inviato nel campo |
details[] |
Un elenco dei messaggi che contengono i dettagli dell'errore. Esiste un insieme comune di tipi di messaggi che le API possono utilizzare. Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo |