10
Ich muss ein Diagramm erstellen, um eine RESTFul-API zu dokumentieren, die Build, welches UML-Diagramm sollte ich verwenden?UML-Diagramm zu Modell-API
Vielen Dank im Voraus,
A
Antwort
11
Sequence diagrams sind ein guter Anfang. Aber Sie sind besser dran, lesen Sie über die verschiedenen types of diagrams, um zu sehen, was Ihr Chef/prof etc wollen.
+0
Ich dachte an ein Kommunikationsdiagramm, aber ein Sequenzdiagramm scheint auch machbar. Danke, – Hugo
2
Es hängt davon ab, was Sie vermitteln möchten, aber wenn eine API angezeigt wird, ist die sequence diagram mein Diagramm.
+0
Danke für Ihren Kommentar =) – Hugo
11
Ein Sequenzdiagramm zeigt die Dynamik eines Systems. Wenn Sie also den Fluss von Anrufen anzeigen möchten, die auftreten, wenn Clients Ihre API aufrufen, haben Sie die Wahl.
Ein Klassendiagramm zeigt die Struktur eines Systems. Wenn Sie also die Methoden-/Funktionssignaturen Ihrer API und deren Verteilung auf verschiedene Typen anzeigen möchten, sollten Sie dies verwenden.
Oder Sie können beide verwenden, um verschiedene Ansichten Ihrer API darzustellen.
+0
Danke für Ihren Kommentar =) denke ich, eine Kombination von beiden der Sieger sein wird =) – Hugo
+0
Sie sind willkommen. Meiner Erfahrung nach sind die meisten funktionsorientierten APIs besser als Klassendiagramme dokumentiert, wobei Klassen als "Module" oder "Komponenten" verwendet werden, um die Funktionen in Gruppen anzuordnen und die API-Funktionen als Methoden zu betrachten. Dies bietet eine bessere Granularität auf der API als ein dynamikorientiertes Diagramm wie ein Sequenzdiagramm. – CesarGon
Verwandte Themen
- 1. jQuery zu PHP zu Highcharts
- 2. Rückkehrliste zu JSON zu Angularjs
- 3. zu XML Dokument zu speichern
- 4. Schwierigkeit, zu TabBarController zu kommen
- 5. NSArray zu NSMutableArray zu NSString
- 6. CURL zu POST zu JIRA
- 7. UIInage zu NSDate zu NSString zu JSON String gibt Nullwert
- 8. tcl exec zu stdout Bedarf umgeleitet Ergebnis zu zu speichernden
- 9. PHP zu öffnen, zu lesen, zu/von mysql Datenbank
- 10. Polymer: Wie HTML zu Bildschirm zu loopen und zu rendern
- 11. 3 Spalten CSV, zu Adjazenz-Matrix, zu Networkgraph, zu Arcplot
- 12. NSString zu CLLocationDegrees zu NSString ist Wert zu verändern
- 13. Empfehlung zu Optimierungsroutine/Einschränkungen zu verwenden
- 14. mod_rewrite Regel zu Abfrage Zeichenfolge zu verhindern
- 15. Haskell: zu reparieren oder nicht zu beheben
- 16. Wie Boost zu zwingen, rpath zu verwenden?
- 17. Ist das zu unveränderbar zu const?
- 18. mit Logrotate zu Apache Logs zu drehen
- 19. Vorteil zu SELECT SELECT DISTINCT zu SELECT
- 20. Linq zu Entitäten Inner Join zu Datagrid
- 21. Wie Gurke zu einer Seite zu sagen?
- 22. genaue Ordner zu CSV zu Python importieren
- 23. Nicht zu Kafka Broker zu produzieren java.nio.BufferUnderflowException
- 24. Pipe-Ausgabe zu Datei zu Funktion
- 25. Git Filter-Zweig zu Stammordner zu entfernen
- 26. JavaScript, wie% 20 zu Raum zu ersetzen
- 27. Was zu importieren, um IOUtils.toString() zu verwenden?
- 28. DAO zu .mdb, zu ADO Vergleich
- 29. Zu GAC oder nicht zu GAC?
- 30. Java zu XSD oder XSD zu Java
@AboutDev Kann mir jemand einen Link zu einem Beispiel oder Beispiel Modellierung von APIs, wie Java API kann, mit Sequenzdiagramme? – Debashisenator