10
Je dois créer un diagramme pour documenter une API RESTFul qui construit, quel diagramme UML dois-je utiliser?Diagramme UML à l'API de modèle
Merci à l'avance,
A
Répondre
11
Sequence diagrams sont un bon début. Mais vous feriez mieux de lire sur les différents types of diagrams pour voir ce que votre patron/prof etc veulent.
+0
Je pensais utiliser un diagramme de communication, mais un diagramme de séquence semble également réalisable. Merci, – Hugo
2
Cela dépend ce que vous voulez transmettre, mais en montrant une API le sequence diagram est mon aller au diagramme.
+0
Merci pour votre commentaire =) – Hugo
11
Un diagramme de séquence montre la dynamique d'un système. Donc, si vous voulez montrer le flux des appels qui se produisent lorsque les clients appellent votre API, alors c'est votre choix.
Un diagramme de classe montre la structure d'un système. Donc, si vous voulez montrer les signatures méthode/fonction de votre API et comment elles sont réparties entre les types, alors c'est ce que vous devriez utiliser.
Ou vous pouvez utiliser les deux pour représenter différents points de vue de votre API.
+0
Merci pour votre commentaire =) Je pense qu'une combinaison des deux sera le gagnant =) – Hugo
+0
Vous êtes les bienvenus. D'après mon expérience, la plupart des API orientées fonctions sont mieux documentées en tant que diagrammes de classes, en utilisant des classes comme «modules» ou «composants» pour organiser les fonctions en groupes et en regardant les fonctions de l'API comme des méthodes. Cela offre un meilleur niveau de granularité sur l'API qu'un diagramme orienté dynamique tel un diagramme de séquence. – CesarGon
@AboutDev Quelqu'un peut-il me fournir un lien vers un exemple ou la modélisation de l'échantillon d'API, comme Java API peut être, en utilisant des diagrammes de séquence? – Debashisenator