Best practice per l'invio di vari dettagli sulla risorsa REST in una risposta dal servizio

0

Stiamo creando API REST che verranno utilizzate dagli utenti Web e Mobile.

La mia domanda è: dobbiamo prendere in considerazione l'interfaccia utente prima di progettare la struttura JSON?

Ad esempio, abbiamo una risorsa Company . Un Company ha più clienti con il suo experiences . Abbiamo creato API company/{company_id}/customers per recuperare l'elenco di clienti per una determinata azienda. In risposta, l'API sta inviando un elenco di clienti con dettagli di base come (ID, nome, indirizzo, email, telefono).

È una buona pratica inviare esperienze cliente con i dettagli del cliente?

Attualmente durante il recupero dei clienti, stiamo inviando solo i dettagli di base dei clienti senza le loro esperienze. Quando facciamo riferimento all'interfaccia utente per dispositivi mobili e al Web, viene mostrata l'esperienza del cliente con i dettagli del cliente nella schermata di elenco dei clienti.

Quindi, questa è una best practice se facciamo più piccole chiamate REST per ottenere altre informazioni?

    
posta mcd 06.01.2018 - 06:36
fonte

1 risposta

2

Non considero l'invio di vari dettagli insieme ai dati principali come impostazione predefinita come buona pratica. Invece, usa alcune opzioni con nome come _with per elencare tutte le entità child che vuoi ottenere in una risposta API. Per il tuo esempio potrebbe essere qualcosa del tipo: company/{company_id}/customers?_with=experience,purchase

Di solito provo a mappare _with elementi nel mio modello di dominio ( Customer è un'entità principale, Experience e Purchase sono relativi ad esso).

Non è consigliabile utilizzare piccole chiamate REST per recuperare i dettagli a causa di motivi di prestazioni. La chiamata REST è una cosa costosa.

    
risposta data 06.01.2018 - 09:44
fonte

Leggi altre domande sui tag