10
Devo creare un diagramma per documentare un'API RESTFul che viene compilata, quale diagramma UML dovrei usare?UML Diagram to Model API
Grazie in anticipo,
A
risposta
11
Sequence diagrams sono un buon inizio. Ma è meglio leggere i diversi types of diagrams per vedere cosa vogliono il tuo capo/prof ecc.
+0
Stavo pensando di usare un diagramma di comunicazione, ma anche un diagramma di sequenza sembra fattibile. Grazie, – Hugo
2
Dipende da ciò che si desidera trasmettere, ma quando si mostra un'API è il sequence diagram il mio go to diagramma.
+0
Grazie per il tuo commento =) – Hugo
11
A diagramma di sequenza mostra la dinamica di un sistema. Quindi, se vuoi mostrare il flusso di chiamate che si verificano quando i client chiamano la tua API, allora quella è la tua scelta.
A diagramma di classe mostra la struttura di un sistema. Quindi, se vuoi mostrare le firme metodo/funzione della tua API e come sono distribuite tra i tipi, allora questo è quello che dovresti usare.
Oppure è possibile utilizzare entrambi per rappresentare viste diverse dell'API.
+0
Grazie per il tuo commento =) penso una combinazione di entrambi sarà il vincitore =) – Hugo
+0
Sei il benvenuto. Nella mia esperienza, la maggior parte delle API orientate alle funzioni sono meglio documentate come diagrammi di classe, usando classi come "moduli" o "componenti" per organizzare le funzioni in gruppi e osservando le funzioni API come metodi. Ciò offre un livello migliore di granularità sull'API rispetto a un diagramma orientato alla dinamica come un diagramma di sequenza. – CesarGon
@AboutDev Qualcuno può fornirmi un collegamento a un esempio o una modellazione di esempio di API, come potrebbe essere l'API Java, utilizzando i diagrammi di sequenza? – Debashisenator