The architecture is based on Implementing header-based API Gateway versioning with Amazon CloudFront from the AWS Compute Blog, which uses the AWS to dynamically route the request to the targeted API version.Īmazon API Gateway is a fully managed service that makes it easier for developers to create, publish, maintain, monitor, and secure APIs at any scale. All diagrams in this post were rendered from a text-based domain specific language using a diagrams-as-code tool instead of being drawn with graphical diagramming software. Each diagram adds to the vocabulary and graphical notation of Sequence Diagrams, then shows how the diagram deepened understanding of the architecture. This post takes a sample architecture and iteratively builds out a set of Sequence Diagrams. Using Sequence Diagrams, you can explore additional usage scenarios and enrich your understanding of the distributed architecture while continuing to communicate visually. As the level of detail increases, so does the diagram’s size, density, and layout complexity. Use it as part of documentation to illustrate only certain points you don't have to use the diagram as the only documentation artifact.Architecture diagrams visually communicate and document the high-level design of a solution. Then enrich it, add text annotation, split it up. The diagram is minimalistic to the point of not being very useful Sounds like a tooling problem just put the lines further apart, or use things like PlantUML that does that for you. There's hardly enough room on the line out and the line back to show all this data , then draw something and see if you understand it or if other people understand it don't be afraid to throw a diagram away if you feel you can "reword" it better. (1) The best way to start is to first learn the "vocabulary" of the diagrams e.g. A rule of thumb is to keep the same level of abstraction in the whole diagram - suddenly diving into implementational details can clutter it very quickly. Again, the deciding factor is clarity of communication - if a single diagram is a too cluttered then break it up and make another one, or dozen more (just like you would split up methods, and classes). Also, you can add notes to your diagram to clarify your intent. Similarly UML has a "vocabulary" of visual elements that represent various concepts - sequence diagrams with their lifelines and messages express a sequence of communication between actors (classes). (3) Would you consider sign language a language even though it uses hand gestures instead of text? Maybe in your case something like this could sufficeįocus on communication first, worry about being "compliant" to UML specs later. The very same goes for diagrams here if you don't understand the diagram yourself (assuming you understand the purpose of sequence diagrams), then other people are not going to understand it either. There really is no "best" way how to go about it, just like there isn't a best way to write this answer - I've already reworded this answer, and if I were to re-read my answer in a year, I would probably reword it again to be more clear. The purpose of the sequence diagram in your case is communicating certain information to your colleagues (or future self). (3) I understand that sequence diagrams are based on UML, but in what way is UML a "language"? There's no text representation of it, right? It seems more a way of diagramming something, like a flowchart. (2) When a flow has different logic paths that result in different web service calls, should I represent these by if/then/else in a single sequence diagram, or create a different sequence diagram for each possibility? (1) Can someone show me some particularly good/useful examples of a sequence diagram for web service calls, so I can see how this is done right? But I see how popular sequence diagrams are, so I think I'm not 'getting' them. I find it a lot easier to document stuff like this in a text file or on a wiki. For example, if I want to show that my app makes a call to a specific service, passing a set of data and getting back a different set of data, there's hardly enough room on the line out and the line back to show all this data and to point out that it's a GET or a POST, and without this information, the diagram is minimalistic to the point of not being very useful. They're difficult to read - lots of lines, not a lot of text. I don't really understand sequence diagrams. I've been asked to make a sequence diagram to document the web service calls made by my application.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |