Uno sviluppatore front-end dovrebbe mai specificare il formato JSON per gli sviluppatori back-end?

17

Sto assumendo il ruolo di front-end in un progetto. Dovrei specificare per i miei compagni di back-end il formato esatto di JSON che il loro PHP restituisce al mio JavaScript?

Ad esempio, dovrei dire loro che dovrebbero usare un formato simile a quello qui descritto:

Modo corretto per strutturare JSON per front-end consumo

O dovrei mantenere il mio ruolo il più sterile possibile e semplicemente descrivere a parole gli input e gli output di cui ho bisogno dalla loro interfaccia di back-end? (Naturalmente, se questo dovesse accadere, potrebbe essere più difficile da parte mia gestire i loro diversi formati di struttura dati)

    
posta LazerSharks 16.12.2014 - 22:44
fonte

4 risposte

41

Questa è una conversazione che dovresti stare insieme, discutendo i requisiti, i pro e i contro di diversi formati.

Se una parte o l'altra sta dettando ciò che accade, finirai con un software scadente e una squadra infelice.

    
risposta data 16.12.2014 - 22:47
fonte
9

Dovresti sicuramente contribuire a come dovrebbe apparire il formato e la struttura del JSON. Lo vedo più spesso che gli ingegneri front-end, i consumatori delle API, sono quelli che sanno come dovrebbe essere la struttura dei dati.

Tu sei quello che userà i dati, lo formatterà, lo passerà in loop e lavorerà con esso. Dovresti avere un'opinione su come vuoi che venga consegnato.

    
risposta data 16.12.2014 - 23:48
fonte
3

Benvenuti nel meraviglioso mondo dello sviluppo del middleware. Può essere molto duro lavorare e discutere per sviluppare un protocollo, e nessuno dovrebbe mai vedere i risultati.

Se fai parte di una piccola squadra, evita un dittatore: organizza riunioni rapide con tutti per risolvere il protocollo.

I team di medie dimensioni potrebbero voler avere rappresentanti che elaborano il protocollo.

I team e / o i team di grandi dimensioni con un'organizzazione complessa dovrebbero disporre di personale dedicato del middleware per il controllo del protocollo.

In tutti i casi document! Quali sono le precondizioni, quali sono le post-condizioni, quali sono i campi obbligatori, quali sono i campi opzionali, quali sono gli effetti collaterali, quali errori vengono restituiti ... Mantiene la vita del documento, quando vengono trovate nuove condizioni, tipi di errore o effetti collaterali, quindi vengono aggiunti al documento.

Vorrei anche raccomandare sia i test di unità client e lato server che i test di sistema per garantire la conformità al documento.

Potrebbe sembrare un sacco di lavoro, ma qui piccoli passi falsi possono essere molto costosi e lunghi.

    
risposta data 17.12.2014 - 13:21
fonte
1

Vorrei solo chiedere Why Not? Quando parliamo di un progetto, parliamo anche del team che ci sta lavorando e ci si aspetta che sia il benvenuto a sentire le opinioni sulle caratteristiche e sulla struttura utilizzata. Come sviluppatore personalmente credo e apprezzo il contributo dei compagni di squadra.

Sai che c'è un detto "se vuoi andare veloce vai da solo, se vuoi andare lontano vai insieme".

    
risposta data 19.12.2014 - 16:54
fonte

Leggi altre domande sui tag