Demo: preview an API request sequence
Sequence diagrams are best when they show responsibility, not every internal function call. A focused preview helps reviewers confirm who calls whom and what the important return values are.
- Show external users or systems as explicit participants.
- Use notes for assumptions rather than adding fake service calls.
- Add alt blocks for failure paths that need operational handling.
sequenceDiagram
participant Browser
participant API
participant DB
Browser->>API: POST /orders
API->>DB: insert order
DB-->>API: order id
API-->>Browser: 201 Created