Progettazione dell'API di Message vs ErrorMessage

Naviga le tue risposte
1

Sto desing API per generico task executor che attualmente supporta due chiamate:

  1. Accetta attività
  2. Ottieni informazioni sull'attività

Il (2) fornisce informazioni dettagliate sull'attività con lo stato dell'attività e il messaggio personalizzato, ad esempio in formato JSON: 

{
   ...
   status: "SUCCESS",
   message: "The task has been finished successfully"
   ...
}

In caso di stato "ERROR" devo avere un campo separato "errorMessage" o è normale scrivere un messaggio di errore nel campo "message" ? Tecnicamente qualsiasi soluzione è possibile, ma sto cercando le migliori pratiche, non ho ancora trovato raccomandazioni rigorose.

    
posta erkfel 13.05.2016 - 00:41
fonte

2 risposte

4

...do I need to have a separate field "errorMessage"?

Solo se è necessario mantenere due messaggi separati in una determinata transazione JSON.

    
risposta data 13.05.2016 - 00:43
fonte
3

Otterrai più chilometri con una coppia di stato / messaggio che con una proprietà errorMessage separata. Ad esempio, se si desidera scrivere una funzione di 'avviso' generale che mostra il lavoro e il relativo stato, sarà un pezzo di codice più pulito per utilizzare lo stato per determinare il colore e mostrare sempre la stessa proprietà 'messaggio'.

    
risposta data 15.05.2016 - 10:54
fonte

Leggi altre domande sui tag

Ricerca binaria O (log (n)) o O (n) Java 8: cosa fa un ritorno vuoto in un costruttore?