Interaction entre un codeur HTML/Javascript et un codeur de langage de script de serveur?

Question

Je ne veux plus que mon codeur PHP écrive Javascript. Je veux séparer le codage javascript et le codage php. Comment dois-je écrire de la documentation sur cette interaction?

Imaginons une requête ajax vraiment simple. Quant à moi, la documentation doit contenir un diagramme de flux de séquence.

1. utilisateur cliquant sur le bouton "modifier"
2. préchargement est présenté à l'utilisateur
3. demande ajax est envoyé à l'URL/ajax_request/catégorie/{category_id} /; nous attendons la réponse au format json
4. le temporisateur a démarré; si la réponse n'est pas reçue dans les 10 secondes - afficher l'alerte "Délai d'expiration de la connexion, s'il vous plaît essayer d'actualiser la page et essayer encore une fois."
5. demande ajax est reçu en données var
6. cacher préchargement
7. vérifier si data.success est faux alors montrer alerte « Quelque chose ne va pas. »
8. data.html de vente dans le conteneur

Comme vous le voyez, il est vraiment difficile d'expliquer ce flux au format texte. Je sais qu'il y a UML pour décrire de telles choses, mais je n'ai aucune expérience. Tous les exemples UML sont trop simples et je ne peux pas comprendre comment construire des diagrammes plus compliqués.

S'il vous plaît, n'importe qui (expert UML), pourriez-vous me montrer comment le diagramme UML va chercher mon exemple.

J'apprécie vraiment toute aide. Je vous remercie!

Answer 1

Il existe plusieurs diagrammes pour votre problème. La question est: "Que voulez-vous représenter?"

• flux de votre étape 1. à votre étape 8 Vous shuold dessiner un schémas de comportement. Vous pouvez utiliser un cas d'utilisation (diagramme pour représenter les actions de l'utilisateur), un diagramme d'activité (représenter la durée de vie d'un algorithme ou d'un processus) ou un diagramme d'états (si vous souhaitez représenter l'évolution d'un composant). la requête http). D'autre part, vous pouvez utiliser un diagramme d'interaction pour représenter l'interdépendance entre le serveur et le client.
• Structure En général, vous devez utiliser un diagramme de classes. En toute simplicité:
  • une classe pour le client;
  • une classe pour le serveur;
  • une classe pour la demande;
  • bla bla

Ce type de diagramme est inutile pour la facilité d'utilisation/activité fonctionnelle pour l'utilisateur.

• UML4WEB Vous pouvez utiliser les diagrammes de Conallen, qui ont fait une extension d'UML pour le WEB project.