Un développeur de front-end spécifie-t-il jamais le format JSON pour les développeurs arrière?
Je prends le rôle frontal dans un projet. Devrais-je préciser pour mes coéquipiers de back-end le format exact de JSON que leur PHP revient à mon JavaScript?
Par exemple, devrais-je leur dire qu'ils devraient utiliser un format similaire à celui décrit ici:
moyen approprié de structurer JSON pour la consommation frontale
Ou devrais-je garder mon rôle aussi stérile que possible et décrivez simplement en mots les entrées et les sorties dont j'ai besoin de leur interface back-end? (Bien sûr, si cela se produit, il peut être plus difficile de gérer leurs différents formats de structure de données)
Ceci est une conversation que vous devriez avoir ensemble, discuter des exigences et des avantages et des inconvénients de différents formats.
Si un côté ou l'autre dicte ce qui se passe, vous allez vous retrouver avec un mauvais logiciel et une équipe malheureuse.
Vous devriez certainement contribuer à la façon dont le format et la structure du Json doivent ressembler. Je le vois plus que souvent que les ingénieurs frontaux, les consommateurs de l'API, sont ceux qui connaissent la manière dont la structure de données devrait être.
Vous êtes celui qui va utiliser les données, le formater, la boucle et le traverse avec elle. Vous devriez avoir une opinion sur la façon dont vous le souhaitez.
Bienvenue dans le monde merveilleux du développement middleware. Cela peut être beaucoup de travail acharné et débat pour développer un protocole et personne ne devrait jamais voir les résultats.
Si vous êtes dans une petite équipe, alors évitez un dictateur: avoir des réunions rapides avec tout le monde pour marteler le protocole.
Les équipes de taille moyenne souhaiteront peut-être avoir des représentants qui élèvent le protocole.
Les grandes équipes et/ou les équipes avec une organisation complexe devraient avoir des personnes de middleware dédiées à contrôler le protocole.
Dans tous les cas, document! Quelles sont les conditions préalables, quelles sont les conditions postérieures, quels sont les champs obligatoires, quels sont les champs facultatifs, quels sont les effets secondaires , quelles erreurs sont retournées ... Gardez le document Vivre lorsque de nouvelles conditions, types d'erreur ou effets secondaires sont trouvés, ils sont ensuite ajoutés au document.
Je recommanderais également des tests d'unité latéraux des clients et du serveur et des tests système pour assurer la conformité au document.
Cela peut sembler beaucoup de travail, mais les mauvaises étages mineurs peuvent être très coûteux et consommer du temps.
Je voudrais juste demander pourquoi pas? Lorsque nous parlons d'un projet, nous parlons également de l'équipe qui y travaille et que nous attendions et devraient être accueillis pour entendre l'opinion sur les caractéristiques et la structure utilisée. En tant que développeur, je crois personnellement et valorisez les contributions des coéquipiers.
Vous savez qu'il y a un dicton "Si vous voulez aller vite aller seul. Si vous voulez aller loin aller ensemble".