Standardizzazione codici di risposta API (Best practice)

Question

Standardizzazione codici di risposta API (Best practice)

#1 da (1 voti)

0

Voglio creare codici di risposta generici, per un'API che sto sviluppando. Ora so che ci sono dei codici di risposta HTTP che di solito si consiglia di utilizzare, ma la mia API gestirà più USSD gateway risposte .

Quindi una mappatura generalizzata dei codici di risposta all'interno dell'API sarà altamente utile. Dopo una breve ricerca su Google, non ho trovato un documento o un articolo sulle migliori pratiche al momento di decidere i codici di risposta (se dovrebbe essere numerico, alfanumerico, di lunghezza, ecc.).

Qualsiasi aiuto o suggerimento sarà molto apprezzato.

design api

posta FaizanRabbani 31.08.2016 - 09:48

fonte

1 risposta

Leggi altre domande sui tag design api

strato anti-corruzione Blue Giga C ++ per l'API callback C? Decisione che guida l'uso di una tecnologia frontale come Javascript per le attività lato server

score 1 · Accepted Answer

Se i codici HTTP non sono abbastanza buoni per te, prendi in considerazione l'implementazione del tuo. Ad esempio, standardizza la risposta dell'API per essere qualcosa del genere:

{
    "status": "OK",
    "status_message": "Success",
    "meta": {
    },
    "data": {
    }
}

Lascia che lo 'stato' sia un identificatore del codice di risposta. 'status_message' - una descrizione testuale di esso.

Nel caso in cui il metodo venga eseguito correttamente, restituisci il codice HTTP 200 + il tuo JSON. In caso si verifichi un errore, restituisci la risposta HTTP 400/500 con il tuo JSON contenente il tuo codice di stato e il messaggio dettagliati.

Ovviamente un esempio sopra è solo un esempio. Non è inteso come una soluzione pronta all'uso.

Conserva una documentazione con un elenco di possibili codici di risposta dalla tua API. Documentare ogni possibile codice di risposta in una documentazione del metodo.